guard-ronn 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.1.0 - August 11, 2011
+
+### Initial release ([@rymai][])
+
+[@rymai]: https://github.com/rymai

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Rémy Coutable
+
+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,90 @@
+# Guard::Ronn [![Build Status](https://secure.travis-ci.org/guard/guard-ronn.png)](http://travis-ci.org/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.
+
+## 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
+```
+
+or manually install the gem:
+
+```bash
+$ gem install guard-ronn
+```
+
+Add Guard definition to your `Guardfile` by running this command:
+
+```bash
+$ guard init ronn
+```
+
+Usage
+-----
+
+Please read [Guard usage doc](https://github.com/guard/guard#readme).
+
+By default, Guard::Ronn watch for files with the `.md` or `.markdown` extension in the `man` directory.
+
+Guardfile
+---------
+
+``` ruby
+guard 'ronn' do
+  watch(%r{^man/.+\.m(ark)?d(own)?$})
+end
+```
+
+Please read [Guard doc](https://github.com/guard/guard#readme) for more information about the Guardfile DSL.
+
+Options
+-------
+
+You can pass any of the standard Ronn CLI options using the `:cli` option:
+
+``` ruby
+guard 'ronn', :cli => "--html" do
+  # ...
+end
+```
+
+### List of available options:
+
+``` ruby
+:cli => "--html"  # pass arbitrary Ronn CLI arguments, default: ""
+:bundler => false # don't use "bundle exec" to run the Ronn command, default: true
+```
+
+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)
+
+Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change you make. Also, please update the README and the CHANGELOG.
+
+Testing
+-------
+
+`bundle exec guard` and `rake spec:portability` (to test against multiple rubies).
+
+Author
+------
+
+[Rémy Coutable](https://github.com/rymai)

data/lib/guard/ronn/formatter.rb

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

data/lib/guard/ronn/formatter.rbc

@@ -0,0 +1,578 @@
+!RBIX
+14325050222978361568
+x
+M
+1
+n
+n
+x
+10
+__script__
+i
+28
+99
+7
+0
+65
+49
+1
+2
+13
+99
+12
+7
+2
+12
+7
+3
+12
+65
+12
+49
+4
+4
+15
+49
+2
+0
+15
+2
+11
+I
+6
+I
+0
+I
+0
+I
+0
+n
+p
+5
+x
+5
+Guard
+x
+11
+open_module
+x
+15
+__module_init__
+M
+1
+n
+n
+x
+5
+Guard
+i
+29
+5
+66
+99
+7
+0
+1
+65
+49
+1
+3
+13
+99
+12
+7
+2
+12
+7
+3
+12
+65
+12
+49
+4
+4
+15
+49
+2
+0
+11
+I
+6
+I
+0
+I
+0
+I
+0
+n
+p
+5
+x
+4
+Ronn
+x
+10
+open_class
+x
+14
+__class_init__
+M
+1
+n
+n
+x
+4
+Ronn
+i
+28
+5
+66
+99
+7
+0
+65
+49
+1
+2
+13
+99
+12
+7
+2
+12
+7
+3
+12
+65
+12
+49
+4
+4
+15
+49
+2
+0
+11
+I
+6
+I
+0
+I
+0
+I
+0
+n
+p
+5
+x
+9
+Formatter
+x
+11
+open_module
+x
+15
+__module_init__
+M
+1
+n
+n
+x
+9
+Formatter
+i
+48
+5
+66
+99
+7
+0
+7
+1
+65
+67
+49
+2
+0
+49
+3
+4
+15
+5
+48
+4
+15
+99
+7
+5
+7
+6
+65
+67
+49
+2
+0
+49
+3
+4
+15
+99
+7
+7
+7
+8
+65
+67
+49
+2
+0
+49
+3
+4
+11
+I
+5
+I
+0
+I
+0
+I
+0
+n
+p
+9
+x
+6
+notify
+M
+1
+n
+n
+x
+6
+notify
+i
+47
+44
+43
+0
+43
+1
+5
+20
+0
+47
+49
+2
+1
+44
+43
+3
+80
+49
+4
+1
+13
+7
+5
+7
+6
+64
+49
+7
+2
+15
+13
+7
+8
+5
+20
+0
+47
+49
+9
+1
+49
+7
+2
+15
+49
+10
+2
+11
+I
+8
+I
+1
+I
+1
+I
+1
+n
+p
+11
+x
+5
+Guard
+x
+8
+Notifier
+x
+13
+guard_message
+x
+4
+Hash
+x
+16
+new_from_literal
+x
+5
+title
+s
+12
+Ronn results
+x
+3
+[]=
+x
+5
+image
+x
+11
+guard_image
+x
+6
+notify
+p
+5
+I
+-1
+I
+5
+I
+0
+I
+6
+I
+2f
+x
+78
+/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn/formatter.rb
+p
+1
+x
+7
+success
+x
+17
+method_visibility
+x
+15
+add_defn_method
+x
+7
+private
+x
+13
+guard_message
+M
+1
+n
+n
+x
+13
+guard_message
+i
+13
+20
+0
+9
+9
+7
+0
+64
+8
+12
+7
+1
+64
+11
+I
+2
+I
+1
+I
+1
+I
+1
+n
+p
+2
+s
+23
+Manual generation done!
+s
+25
+Manual generation failed!
+p
+7
+I
+-1
+I
+b
+I
+0
+I
+c
+I
+c
+I
+0
+I
+d
+x
+78
+/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn/formatter.rb
+p
+1
+x
+7
+success
+x
+11
+guard_image
+M
+1
+n
+n
+x
+11
+guard_image
+i
+11
+20
+0
+9
+8
+7
+0
+8
+10
+7
+1
+11
+I
+2
+I
+1
+I
+1
+I
+1
+n
+p
+2
+x
+7
+success
+x
+6
+failed
+p
+7
+I
+-1
+I
+10
+I
+0
+I
+11
+I
+a
+I
+0
+I
+b
+x
+78
+/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn/formatter.rb
+p
+1
+x
+7
+success
+p
+9
+I
+2
+I
+5
+I
+10
+I
+9
+I
+14
+I
+b
+I
+22
+I
+10
+I
+30
+x
+78
+/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn/formatter.rb
+p
+0
+x
+13
+attach_method
+p
+3
+I
+2
+I
+3
+I
+1c
+x
+78
+/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn/formatter.rb
+p
+0
+x
+13
+attach_method
+p
+3
+I
+2
+I
+2
+I
+1d
+x
+78
+/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn/formatter.rb
+p
+0
+x
+13
+attach_method
+p
+3
+I
+0
+I
+1
+I
+1c
+x
+78
+/Users/remy/Development/Ruby/Gems/guard/guard-ronn/lib/guard/ronn/formatter.rb
+p
+0

data/lib/guard/ronn/inspector.rb

@@ -0,0 +1,36 @@
+module Guard
+  class Ronn
+    module Inspector
+      class << self
+        def clean(paths)
+          paths.uniq!
+          paths.compact!
+          clear_markdown_files_list_after do
+            paths = paths.select { |path| markdown_file?(path) }
+          end
+          paths.reject { |p| included_in_other_path?(p, paths) }
+        end
+
+      private
+
+        def markdown_file?(path)
+          markdown_files.include?(path)
+        end
+
+        def markdown_files
+          @markdown_files ||= Dir["man/*.{md,markdown}"]
+        end
+
+        def clear_markdown_files_list_after
+          yield
+          @markdown_files = nil
+        end
+
+        def included_in_other_path?(path, paths)
+          (paths - [path]).any? { |p| path.include?(p) && path.sub(p, '').include?('/') }
+        end
+
+      end
+    end
+  end
+end