guard-treetop 0.1.0

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Zeh Rizzatti
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,58 @@
+# Guard::Treetop [![Build Status][build-status]][travis]
+
+Guard::Treetop compiles your treetop grammars to ruby files using guard.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'guard-treetop'
+end
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install guard-treetop
+```
+
+## Usage
+
+```bash
+$ bundle exec guard init treetop
+```
+
+And edit your `Guardfile`.
+
+## Options
+
+```ruby
+:input => 'grammars'          # Relative path to the root directory.
+                              # Will compile .tt and .treetop files inside
+                              # default: nil
+
+:output => 'lib/parsers'      # Relative path to the root directory.
+                              # default: the same as :input
+
+:all_on_start => false        # Run compilation when guard starts
+                              # default: false
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[build-status]: https://travis-ci.org/zehrizzatti/guard-treetop.png
+[travis]: https://travis-ci.org/zehrizzatti/guard-treetop

data/lib/guard/treetop/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module TreetopVersion
+    VERSION = '0.1.0'
+  end
+end

data/lib/guard/treetop.rb

@@ -0,0 +1,51 @@
+require 'guard'
+require 'guard/guard'
+require 'guard/treetop/version'
+require 'treetop'
+
+module Guard
+  class Treetop < Guard
+    include TreetopVersion
+
+    DEFAULT_OPTIONS = {
+      :all_on_start => false
+    }
+
+    attr_reader :compiler
+
+    def initialize(watchers=[], options={})
+      watchers ||= []
+      defaults = DEFAULT_OPTIONS.clone
+
+      if options[:input]
+        input = options.delete(:input)
+        defaults.merge!({:output => input})
+        watchers << ::Guard::Watcher.new(%r{#{input}/(.+)(\.treetop|\.tt)})
+      end
+
+      super(watchers, defaults.merge!(options))
+
+      @compiler = ::Treetop::Compiler::GrammarCompiler.new
+    end
+
+    def start
+      run_all if options[:all_on_start]
+    end
+
+    def run_all
+      run_on_changes(Watcher.match_files(self, Dir.glob('**/*.{tt,treetop}')))
+    end
+
+    def run_on_changes(paths)
+      tuples = paths.map do |path|
+        basename = File.basename(path).gsub(/\.(tt|treetop)\z/, '.rb')
+        dirname = options[:output] || File.dirname(path)
+        output = File.join(dirname, basename)
+        [path, output]
+      end
+      tuples.each { |e| compiler.compile(*e) }
+    rescue StandardError
+      throw :task_has_failed
+    end
+  end
+end

data/spec/lib/guard/treetop_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require 'guard/treetop'
+
+module Guard
+  describe Treetop do
+    describe 'the class' do
+      it 'has a version number' do
+        subject.class::VERSION.should == TreetopVersion::VERSION
+      end
+    end
+
+    describe '#initialize' do
+      context 'when no options are provided' do
+        it 'sets a default :all_on_start option' do
+          subject.options[:all_on_start].should be_false
+        end
+
+        it 'has no :input option' do
+          subject.options[:input].should be_nil
+        end
+
+        it 'has no :output option' do
+          subject.options[:output].should be_nil
+        end
+      end
+
+      context 'with options provided' do
+        subject { Treetop.new(nil, {:all_on_start => true}) }
+
+        it 'sets the provided :all_on_start option' do
+          subject.options[:all_on_start].should be_true
+        end
+      end
+
+      context 'with :input provided' do
+        subject { Treetop.new(nil, {:input => 'lib'}) }
+
+        it 'removes the provided :input' do
+          subject.options[:input].should be_nil
+        end
+
+        it 'has one watcher' do
+          subject.should have(1).watchers
+        end
+
+        it 'watchers *.treetop and *.tt files' do
+          subject.watchers.first.pattern.should == %r{lib/(.+)(\.treetop|\.tt)}
+        end
+
+        context 'and no :output provided' do
+          it 'outputs to the same directory as input' do
+            subject.options[:output].should == 'lib'
+          end
+        end
+
+        context 'and :output is provided' do
+          let(:options) do
+            {:input => 'lib/inputs', :output => 'lib/outputs'}
+          end
+          subject { Treetop.new(nil, options) }
+
+          it 'respects the provided :output' do
+            subject.options[:output].should == 'lib/outputs'
+          end
+        end
+      end
+    end
+
+    describe '#start' do
+      context 'without all_on_start' do
+        it 'should not call run_all' do
+          subject.should_not_receive(:run_all)
+          subject.start
+        end
+      end
+
+      context 'with all_on_start' do
+        subject { Treetop.new(nil, :all_on_start => true) }
+
+        it 'should call run_all' do
+          subject.should_receive(:run_all)
+          subject.start
+        end
+      end
+    end
+
+    context 'running without output' do
+      subject { Treetop.new(nil, :input => 'inputs') }
+      let(:inputs) { ['inputs/1.tt', 'inputs/2.treetop'] }
+      let(:outputs) { ['inputs/1.rb', 'inputs/2.rb'] }
+      before(:all) { Dir.stub(:glob).and_return(inputs) }
+
+      it 'should call run_on_changes' do
+        subject.should_receive(:run_on_changes).with(inputs)
+        subject.run_all
+      end
+
+      it 'throws :task_has_failed on error' do
+        expect { subject.run_on_changes(['/tmp/non_existent']) }.to throw_symbol :task_has_failed
+      end
+
+      it 'calls run_on_changes' do
+        files = [inputs, outputs].transpose
+        subject.compiler.should_receive(:compile).with(*files.first)
+        subject.compiler.should_receive(:compile).with(*files.last)
+        subject.run_on_changes(inputs)
+      end
+    end
+
+    context 'running with output' do
+      subject { Treetop.new(nil, :input => 'inputs', :output => 'outputs') }
+      let(:inputs) { ['inputs/1.tt', 'inputs/2.treetop'] }
+      let(:outputs) { ['outputs/1.rb', 'outputs/2.rb'] }
+      before(:all) { Dir.stub(:glob).and_return(inputs) }
+
+      it 'calls run_on_changes' do
+        files = [inputs, outputs].transpose
+        subject.compiler.should_receive(:compile).with(*files.first)
+        subject.compiler.should_receive(:compile).with(*files.last)
+        subject.run_on_changes(inputs)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems' unless defined? Gem
+require 'bundler/setup'
+require 'rspec'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: guard-treetop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Zeh Rizzatti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: Guard::Treetop automatically compiles your treetop grammars
+email:
+- zehrizzatti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/guard/treetop/version.rb
+- lib/guard/treetop.rb
+- spec/lib/guard/treetop_spec.rb
+- spec/spec_helper.rb
+- README.md
+- LICENSE.txt
+homepage: https://github.org/zehrizzatti/guard-treetop
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Guard gem for Treetop
+test_files:
+- spec/lib/guard/treetop_spec.rb
+- spec/spec_helper.rb
+has_rdoc: