guard-ronn 0.2.0 → 1.0

data/CHANGELOG.md

@@ -1,6 +1,20 @@
+## git master
+
+### Improvements
+
+* Rename `Formatter` to `Notifier` and instantiate it in `Runner`'s constructor. ([@rymai][])
+* Use an instance of Runner instead of calling a class method on it. ([@rymai][])
+* Get rid of `autoload`. ([@rymai][])
+
+## 1.0 - April 20, 2013
+
+### Bug fix
+
+* Ensure #run_all generates manual for Ronn files only!. ([@rymai][])
+
 ## 0.2.0 - June 3, 2012
 
-### Change:
+### Change
 
 * Updated for Guard 1.1 ([@rymai][])
 

data/README.md

@@ -1,37 +1,25 @@
-# Guard::Ronn [![Build Status](https://secure.travis-ci.org/guard/guard-ronn.png)](http://travis-ci.org/guard/guard-ronn)
+# Guard::Ronn [![Gem Version](https://badge.fury.io/rb/guard-ronn.png)](http://badge.fury.io/rb/guard-ronn) [![Build Status](https://travis-ci.org/guard/guard-ronn.png?branch=master)](https://travis-ci.org/guard/guard-ronn) [![Dependency Status](https://gemnasium.com/guard/guard-ronn.png)](https://gemnasium.com/guard/guard-ronn) [![Code Climate](https://codeclimate.com/github/guard/guard-ronn.png)](https://codeclimate.com/github/guard/guard-ronn) [![Coverage Status](https://coveralls.io/repos/guard/guard-ronn/badge.png?branch=master)](https://coveralls.io/r/guard/guard-ronn)
 
 [Ronn](https://github.com/rtomayko/ronn) guard automatically build manuals when markdown source files are modified.
 
-## Compatibility
-
 * Compatible with Ronn ~> 0.7.3.
-* Tested on Ruby 1.8.7, 1.9.2, REE, Rubinius & JRuby.
+* Tested against Ruby 1.8.7, 1.9.3, REE, Rubinius & JRuby.
 
 ## Install
 
-Please be sure to have [Guard](https://github.com/guard/guard) installed before continue.
-
-If you're using Bundler, add it to your `Gemfile` (inside the `development` or `guard` group):
-
-```ruby
-gem 'guard-ronn'
-```
-
-and run:
-
-```bash
-$ bundle install
-```
+Please be sure to have [Guard](https://github.com/guard/guard) installed before continuing.
 
-or manually install the gem:
+Add the gem to your Gemfile (inside the `:development` or `:tool` group):
 
-```bash
-$ gem install guard-ronn
+``` ruby
+group :development do
+  gem 'guard-ronn'
+end
 ```
 
-Add Guard definition to your `Guardfile` by running this command:
+Add guard definition to your Guardfile by running this command:
 
-```bash
+``` bash
 $ guard init ronn
 ```
 
@@ -43,14 +31,9 @@ By default, Guard::Ronn watch for files with the `.ronn`, `.md` or `.markdown` e
 
 ## Guardfile
 
-``` ruby
-guard 'ronn' do
-  watch(%r{^man/.+\.ronn$})
-  watch(%r{^man/.+\.m(ark)?d(own)?$})
-end
-```
+See the [template Guardfile](https://github.com/guard/guard-ronn/blob/master/lib/guard/ronn/templates/Guardfile) for some examples.
 
-Please read [Guard doc](https://github.com/guard/guard#readme) for more information about the Guardfile DSL.
+Please read the [Guard documentation](https://github.com/guard/guard#readme) for more info about the Guardfile DSL.
 
 ## Options
 
@@ -62,10 +45,10 @@ guard 'ronn', :cli => "--html" do
 end
 ```
 
-### List of available options:
+### Available options
 
 ``` ruby
-:cli => "--html"  # pass arbitrary Ronn CLI arguments, default: ""
+:cli => '--html'  # pass arbitrary Ronn CLI arguments, default: ''
 :bundler => false # don't use "bundle exec" to run the Ronn command, default: true
 ```
 
@@ -75,23 +58,25 @@ You can use the awesome [gem-man](https://github.com/defunkt/gem-man) by [defunk
 
 ## Development
 
-* Source hosted at [GitHub](https://github.com/guard/guard-ronn)
-* Report issues/Questions/Feature requests on [GitHub Issues](https://github.com/guard/guard-ronn/issues)
+* Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard-ronn/master/frames).
+* Source hosted at [GitHub](https://github.com/guard/guard-ronn).
 
-Pull requests are very welcome! Please try to follow these simple "rules", though:
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
 
-- Please create a topic branch for every separate change you make;
-- Make sure your patches are well tested;
-- Update the README (if applicable);
-- Update the CHANGELOG (maybe not for a typo but don't hesitate!);
-- Please do not change the version number.
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested. All specs must pass on [Travis CI](https://travis-ci.org/guard/guard-ronn).
+* Update the [Yard](http://yardoc.org/) documentation.
+* Update the [README](https://github.com/guard/guard-ronn/blob/master/README.md).
+* Update the [CHANGELOG](https://github.com/guard/guard-ronn/blob/master/CHANGELOG.md) for noteworthy changes (don't forget to run `bundle exec pimpmychangelog` and watch the magic happen)!
+* Please **do not change** the version number.
 
-For questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
+For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).
 
-## Testing
+## Author
 
-`bundle exec guard` and `rake spec:portability` (to test against multiple rubies).
+[Rémy Coutable](https://github.com/rymai) ([@rymai](http://twitter.com/rymai), [rymai.me](http://rymai.me))
 
-## Author
+## Contributors
 
-[Rémy Coutable](https://github.com/rymai)
+https://github.com/guard/guard-ronn/contributors

data/lib/guard/ronn.rb

@@ -4,14 +4,15 @@ require 'ronn'
 
 module Guard
   class Ronn < Guard
-    autoload :Runner,    'guard/ronn/runner'
-    autoload :Inspector, 'guard/ronn/inspector'
-    autoload :Formatter, 'guard/ronn/formatter'
+    require 'guard/ronn/runner'
+    require 'guard/ronn/inspector'
+    require 'guard/ronn/notifier'
 
-    def initialize(watchers=[], options={})
+    attr_reader :runner
+
+    def initialize(watchers = [], options = {})
       super
-      @options = {
-      }.merge(options)
+      @runner = Runner.new(@options)
     end
 
     # Call once when guard starts
@@ -20,11 +21,11 @@ module Guard
     end
 
     def run_all
-      Runner.run(["man/*"], @options.merge(:message => "Building all manuals"))
+      @runner.run(Inspector.ronn_files, :message => 'Building all manuals')
     end
 
-    def run_on_change(paths)
-      Runner.run(Inspector.clean(paths), @options)
+    def run_on_changes(paths)
+      @runner.run(Inspector.clean(paths))
     end
 
   end

data/lib/guard/ronn/inspector.rb

@@ -11,16 +11,16 @@ module Guard
           paths.reject { |p| included_in_other_path?(p, paths) }
         end
 
+        def ronn_files
+          @ronn_files ||= Dir['man/*.{ronn,md,markdown}']
+        end
+
       private
 
         def ronn_file?(path)
           ronn_files.include?(path)
         end
 
-        def ronn_files
-          @ronn_files ||= Dir["man/*.{ronn,md,markdown}"]
-        end
-
         def clear_ronn_files_list_after
           yield
           @ronn_files = nil

data/lib/guard/ronn/notifier.rb

@@ -0,0 +1,24 @@
+module Guard
+  class Ronn
+    class Notifier
+
+      def notify(result)
+        @result = result
+
+        ::Guard::Notifier.notify(guard_message, :title => 'Ronn results',
+                                                :image => guard_image)
+      end
+
+      private
+
+      def guard_message
+        @result ? 'Manual generation done!' : 'Manual generation failed!'
+      end
+
+      def guard_image
+        @result ? :success : :failed
+      end
+
+    end
+  end
+end

data/lib/guard/ronn/runner.rb

@@ -1,36 +1,43 @@
-require "#{File.dirname(__FILE__)}/formatter"
-
 module Guard
   class Ronn
-    module Runner
-      class << self
-        include Formatter
-
-        def run(paths, options={})
-          return false if paths.empty?
-          message = options[:message] || "Running: #{paths.join(' ')}"
-          UI.info(message, :reset => true)
-          success = system(ronn_command(paths, options))
-          notify(success)
-        end
+    class Runner
 
-      private
+      attr_reader :notifier
+
+      def initialize(options = {})
+        @options  = options
+        @notifier = Notifier.new
+      end
 
-        def ronn_command(paths, options={})
-          cmd_parts = []
-          cmd_parts << "bundle exec" if bundler? && options[:bundler] != false
-          cmd_parts << "ronn"
-          cmd_parts << options[:cli] if options[:cli]
-          cmd_parts << paths.join(' ')
+      def run(paths, options = {})
+        return false if paths.empty?
 
-          cmd_parts.join(' ')
-        end
+        options = @options.merge(options)
+        message = options[:message] || "Running: #{paths.join(' ')}"
 
-        def bundler?
-          @bundler ||= File.exist?("#{Dir.pwd}/Gemfile")
-        end
+        ::Guard::UI.info(message, :reset => true)
 
+        result = system(ronn_command(paths, options))
+
+        @notifier.notify(result)
       end
+
+      private
+
+      def ronn_command(paths, options = {})
+        cmd_parts = []
+        cmd_parts << 'bundle exec' if bundler? && options[:bundler] != false
+        cmd_parts << 'ronn'
+        cmd_parts << options[:cli] if options[:cli]
+        cmd_parts << paths.join(' ')
+
+        cmd_parts.join(' ')
+      end
+
+      def bundler?
+        @bundler ||= File.exist?("#{Dir.pwd}/Gemfile")
+      end
+
     end
   end
 end

data/lib/guard/ronn/templates/Guardfile

@@ -1,4 +1,4 @@
-guard 'ronn' do
+guard :ronn do
   watch(%r{^man/.+\.ronn$})
   watch(%r{^man/.+\.m(ark)?d(own)?$})
 end

data/lib/guard/ronn/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module RonnVersion
-    VERSION = '0.2.0'
+    VERSION = '1.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-ronn
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: '1.0'
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-03 00:00:00.000000000 Z
+date: 2013-04-20 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.1.0
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: ronn
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.13'
 description: Guard::Ronn automatically builds manual pages.
 email:
 - remy@rymai.me
@@ -82,17 +82,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/guard/ronn/formatter.rb
-- lib/guard/ronn/formatter.rbc
 - lib/guard/ronn/inspector.rb
-- lib/guard/ronn/inspector.rbc
+- lib/guard/ronn/notifier.rb
 - lib/guard/ronn/runner.rb
-- lib/guard/ronn/runner.rbc
 - lib/guard/ronn/templates/Guardfile
 - lib/guard/ronn/version.rb
-- lib/guard/ronn/version.rbc
 - lib/guard/ronn.rb
-- lib/guard/ronn.rbc
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -110,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4185925842452830406
+      hash: 2627442652966117863
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,10 +114,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4185925842452830406
+      hash: 2627442652966117863
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Guard gem for Ronn.

data/lib/guard/ronn.rbc

@@ -1,746 +0,0 @@
-!RBIX
-14325050222978361568
-x
-M
-1
-n
-n
-x
-10
-__script__
-i
-55
-5
-7
-0
-64
-47
-49
-1
-1
-15
-5
-7
-2
-64
-47
-49
-1
-1
-15
-5
-7
-3
-64
-47
-49
-1
-1
-15
-99
-7
-4
-65
-49
-5
-2
-13
-99
-12
-7
-6
-12
-7
-7
-12
-65
-12
-49
-8
-4
-15
-49
-6
-0
-15
-2
-11
-I
-6
-I
-0
-I
-0
-I
-0
-n
-p
-9
-s
-5
-guard
-x
-7
-require
-s
-11
-guard/guard
-s
-4
-ronn
-x
-5
-Guard
-x
-11
-open_module
-x
-15
-__module_init__
-M
-1
-n
-n
-x
-5
-Guard
-i
-31
-5
-66
-99
-7
-0
-45
-1
-2
-65
-49
-3
-3
-13
-99
-12
-7
-4
-12
-7
-5
-12
-65
-12
-49
-6
-4
-15
-49
-4
-0
-11
-I
-6
-I
-0
-I
-0
-I
-0
-n
-p
-7
-x
-4
-Ronn
-x
-5
-Guard
-n
-x
-10
-open_class
-x
-14
-__class_init__
-M
-1
-n
-n
-x
-4
-Ronn
-i
-91
-5
-66
-5
-7
-0
-7
-1
-64
-47
-49
-2
-2
-15
-5
-7
-3
-7
-4
-64
-47
-49
-2
-2
-15
-5
-7
-5
-7
-6
-64
-47
-49
-2
-2
-15
-99
-7
-7
-7
-8
-65
-67
-49
-9
-0
-49
-10
-4
-15
-99
-7
-11
-7
-12
-65
-67
-49
-9
-0
-49
-10
-4
-15
-99
-7
-13
-7
-14
-65
-67
-49
-9
-0
-49
-10
-4
-15
-99
-7
-15
-7
-16
-65
-67
-49
-9
-0
-49
-10
-4
-11
-I
-5
-I
-0
-I
-0
-I
-0
-n
-p
-17
-x
-6
-Runner
-s
-17
-guard/ronn/runner
-x
-8
-autoload
-x
-9
-Inspector
-s
-20
-guard/ronn/inspector
-x
-9
-Formatter
-s
-20
-guard/ronn/formatter
-x
-10
-initialize
-M
-1
-n
-n
-x
-10
-initialize
-i
-42
-23
-0
-10
-9
-35
-0
-19
-0
-15
-23
-1
-10
-23
-44
-43
-0
-78
-49
-1
-1
-19
-1
-15
-54
-89
-2
-15
-44
-43
-0
-78
-49
-1
-1
-20
-1
-49
-3
-1
-38
-4
-11
-I
-4
-I
-2
-I
-0
-I
-2
-n
-p
-5
-x
-4
-Hash
-x
-16
-new_from_literal
-x
-10
-initialize
-x
-5
-merge
-x
-8
-@options
-p
-9
-I
--1
-I
-b
-I
-17
-I
-c
-I
-1b
-I
-e
-I
-27
-I
-d
-I
-2a
-x
-68
-/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn.rb
-p
-2
-x
-8
-watchers
-x
-7
-options
-x
-17
-method_visibility
-x
-15
-add_defn_method
-x
-5
-start
-M
-1
-n
-n
-x
-5
-start
-i
-22
-45
-0
-1
-7
-2
-44
-43
-3
-49
-4
-0
-47
-101
-5
-7
-6
-63
-3
-49
-7
-1
-11
-I
-4
-I
-0
-I
-0
-I
-0
-n
-p
-8
-x
-2
-UI
-n
-s
-34
-Guard::Ronn is running, with Ronn 
-x
-4
-Ronn
-x
-7
-version
-x
-4
-to_s
-s
-1
-!
-x
-4
-info
-p
-5
-I
--1
-I
-12
-I
-0
-I
-13
-I
-16
-x
-68
-/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn.rb
-p
-0
-x
-7
-run_all
-M
-1
-n
-n
-x
-7
-run_all
-i
-34
-45
-0
-1
-7
-2
-64
-35
-1
-39
-3
-44
-43
-4
-79
-49
-5
-1
-13
-7
-6
-7
-7
-64
-49
-8
-2
-15
-49
-9
-1
-49
-10
-2
-11
-I
-7
-I
-0
-I
-0
-I
-0
-n
-p
-11
-x
-6
-Runner
-n
-s
-5
-man/*
-x
-8
-@options
-x
-4
-Hash
-x
-16
-new_from_literal
-x
-7
-message
-s
-20
-Building all manuals
-x
-3
-[]=
-x
-5
-merge
-x
-3
-run
-p
-5
-I
--1
-I
-16
-I
-0
-I
-17
-I
-22
-x
-68
-/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn.rb
-p
-0
-x
-13
-run_on_change
-M
-1
-n
-n
-x
-13
-run_on_change
-i
-11
-45
-0
-1
-20
-0
-39
-2
-49
-3
-2
-11
-I
-4
-I
-1
-I
-1
-I
-1
-n
-p
-4
-x
-6
-Runner
-n
-x
-8
-@options
-x
-3
-run
-p
-5
-I
--1
-I
-1a
-I
-0
-I
-1b
-I
-b
-x
-68
-/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn.rb
-p
-1
-x
-5
-paths
-p
-15
-I
-2
-I
-7
-I
-d
-I
-8
-I
-18
-I
-9
-I
-23
-I
-b
-I
-31
-I
-12
-I
-3f
-I
-16
-I
-4d
-I
-1a
-I
-5b
-x
-68
-/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn.rb
-p
-0
-x
-13
-attach_method
-p
-3
-I
-2
-I
-6
-I
-1f
-x
-68
-/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn.rb
-p
-0
-x
-13
-attach_method
-p
-9
-I
-0
-I
-1
-I
-9
-I
-2
-I
-12
-I
-3
-I
-1b
-I
-5
-I
-37
-x
-68
-/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn.rb
-p
-0