Module: Hoe::Kpeg

Defined in:
lib/hoe/kpeg.rb

Overview

Kpeg plugin for hoe.

Tasks Provided:

parser

Generate parsers for all .kpeg files in your manifest

.kpeg -> .rb rule

Generate a parser using kpeg.

NOTE: This plugin is derived from the Hoe::Racc and used under the MIT license:

Copyright © Ryan Davis, seattle.rb

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#kpeg_flags ⇒ Object

Optional: Defines what flags to use for kpeg. default: “-s -v”



50
51
52
 
# File 'lib/hoe/kpeg.rb', line 50

def kpeg_flags
  @kpeg_flags
end

#kpeg_tasks ⇒ Object

Optional: Defines what tasks need to generate parsers first.

Defaults to [:multi, :test, :check_manifest]

If you have extra tasks that require your parser to be built, add their names here in your hoe spec. eg:

kpeg_tasks << :debug



45
46
47
 
# File 'lib/hoe/kpeg.rb', line 45

def kpeg_tasks
  @kpeg_tasks
end

Instance Method Details

#define_kpeg_tasks ⇒ Object

Define tasks for kpeg plugin



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/hoe/kpeg.rb', line 69

def define_kpeg_tasks
  kpeg_files   = self.spec.files.find_all { |f| f =~ /\.kpeg$/ }

  parser_files = kpeg_files.map { |f| f.sub(/\.kpeg$/, ".rb") }

  self.clean_globs += parser_files

  rule ".rb" => ".kpeg" do |t|
    kpeg = Gem.bin_path "kpeg", "kpeg"

    begin
      ruby "-rubygems #{kpeg} #{kpeg_flags} -o #{t.name} #{t.source}"
    rescue
      abort "need kpeg, please run rake check_extra_deps"
    end
  end

  desc "build the parser" unless parser_files.empty?
  task :parser

  task :parser => parser_files

  kpeg_tasks.each do |t|
    task t => :parser
  end
end

#initialize_kpeg ⇒ Object

Initialize variables for kpeg plugin.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/hoe/kpeg.rb', line 55

def initialize_kpeg
  self.kpeg_tasks = [:multi, :test, :check_manifest]

  # -f = overwrite existing file
  # -s = parser does not require runtime
  # -v = verbose
  self.kpeg_flags ||= "-s -v -f"

  dependency 'kpeg', '~> 0.9', :development
end