ruboty-megen 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0b8e907e8d2da94d412bb0417e9de0f34dd7ae7
-  data.tar.gz: 8a8b547c2ae29b332a641a037418c83af3b6e403
+  metadata.gz: cd9e3845a22ba4ba906e9b3bb805e77cd9201ad3
+  data.tar.gz: 6dd40f19d972f8adfcacb34a1847a2a4a3f8d34e
 SHA512:
-  metadata.gz: 49140940eff3dbb0ba1b25b8db275d8a1b87e5d76f601c2652436aa2cf4e4dd9ea35801e52424e7f85a6123286ed9c18d9a8d9e3997c6e5a4ab2d065df4b963e
-  data.tar.gz: ecaa7a2294dfcacbdef7f643a7b42fe956b450796fe0366a83841e9e3cf597f1943c8003cd757583cf9307b14946be014f405ed8197755a76636a95ab776e841
+  metadata.gz: 61160373f68d4194112f616d568a78954bd0ff5f3572d59f1ac26f5f73930cbab293a200bfc6c8e96c510d6923b3e6f799c2b44a4f55d47cc936aa287181f4d3
+  data.tar.gz: 8c6dec855603d32473f6622196a6b1bc50f5cdb92113296d2f90724573be57cce4aa529fa61e0f5e2d5bb43f78e5c7b1a7291e87ecff0692c13d88e230baff53

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v.1.0.2
+2014/12/10
+
+### New Feature
+* Add example attribute to Command Model
+
 ## v.1.0.1
 2014/11/12
 
@@ -16,4 +22,4 @@ nothing
 ## v.0.0.1
 2014/11/10
 
-* first release
+* first release

data/README.md

@@ -40,6 +40,7 @@ Or install it yourself as:
 |commands/command name|Ruboty::Handler.on name|ume|
 |commands/command pattern|Ruboty::Handler.on pattern|/ume (?<count>.*?)\z/  |
 |commands/command description|Ruboty::Handler.on description|output empty message N lines (<count> times)|
+|commands/command example|Ruboty::Handler.on example|example usage|
 
 ## Usage
 ### init
@@ -82,12 +83,42 @@ command do |c|
   c.name "ume"
   c.pattern "/ume (?<count>.*?)\z/"
   c.description "output empty message N lines (<count> times)"
+  c.example <<-EOS
+> ruboty help
+ruboty /ume (?<count>.*?)\z/               - output empty message N lines (<count> times)
+> ruboty ume 3
+.
+.
+.
+> ruboty ume 5
+.
+.
+.
+.
+.
+  EOS
 end
 
 command do |c|
   c.name "umec"
   c.pattern "/umec (?<text>.+?) (?<count>.*?)\z/"
   c.description "output <text> message N lines (<count> times)"
+  c.example <<-EOS
+> ruboty help
+ruboty /umec (?<text>.+?) (?<count>.*?)\z/ - output <text> message N lines (<count> times)
+> ruboty umec hoge 3
+hoge
+hoge
+hoge
+
+> ruboty umec hoge 5
+hoge
+hoge
+hoge
+hoge
+hoge
+
+  EOS
 end
 ~~~
 

data/lib/ruboty/gen/readme.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 require 'erb'
 
+# rubocop:disable LineLength
 module Ruboty
   module Gen
     # ReadmeGen Core
     class Readme
-      # rubocop:disable LineLength
       README = 'README.md'
       RUBOTY_MEGEN_FILE = 'Rubotyme'
       RUBOTY_MEGEN_TEMPLATE = <<-EOS
@@ -80,6 +80,11 @@ command do |c|
   # description allow only String
   # description's default value => ""
   c.description ""
+
+  # example
+  # example allow only String
+  # example's default value => ""
+  c.example ""
 end
       EOS
 
@@ -136,7 +141,6 @@ Or install it yourself as:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
       EOS
-      # rubocop:enable LineLength
 
       # generate Rubotymegenfile to current directory.
       def self.init
@@ -191,7 +195,8 @@ Or install it yourself as:
         usages = commands.each_with_object([]) do |e, memo|
           name = e.read_name
           description = e.read_description
-          row = ["### #{name}", "* #{description}", '', '~~~', '', '~~~']
+          example = e.read_example
+          row = ["### #{name}", "* #{description}", '', '~~~', example.chomp, '~~~']
           memo << row.join("\n")
         end
         usages.join("\n\n")
@@ -225,3 +230,4 @@ Or install it yourself as:
     end
   end
 end
+# rubocop:enable LineLength

data/lib/ruboty/gen/version.rb

@@ -2,6 +2,6 @@
 module Ruboty
   # Gen
   module Gen
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
   end
 end

data/lib/ruboty/models/command.rb

@@ -1,30 +1,34 @@
-# encoding: utf-8
-
-module Ruboty
-  module Models
-    # Command
-    class Command
-      def initialize
-        @name, @pattern, @description = ''
-      end
-
-      def name(name)
-        @name = name
-      end
-
-      def pattern(pattern)
-        @pattern = pattern
-      end
-
-      def description(description)
-        @description = description
-      end
-
-      [:name, :pattern, :description].each do |m|
-        define_method :"read_#{m}" do
-          instance_variable_get("@#{m}")
-        end
-      end
-    end
-  end
-end
+# encoding: utf-8
+
+module Ruboty
+  module Models
+    # Command
+    class Command
+      def initialize
+        @name, @pattern, @description = '', @example = ''
+      end
+
+      def name(name)
+        @name = name
+      end
+
+      def pattern(pattern)
+        @pattern = pattern
+      end
+
+      def description(description)
+        @description = description
+      end
+
+      def example(example)
+        @example = example
+      end
+
+      [:name, :pattern, :description, :example].each do |m|
+        define_method :"read_#{m}" do
+          instance_variable_get("@#{m}")
+        end
+      end
+    end
+  end
+end

data/sample/README.md

@@ -33,13 +33,37 @@ Or install it yourself as:
 * output empty message N lines (<count> times)
 
 ~~~
-
+> ruboty help
+ruboty /ume (?<count>.*?)z/               - output empty message N lines (<count> times)
+> ruboty ume 3
+.
+.
+.
+> ruboty ume 5
+.
+.
+.
+.
+.
 ~~~
 
 ### umec
 * output <text> message N lines (<count> times)
 
 ~~~
+> ruboty help
+ruboty /umec (?<text>.+?) (?<count>.*?)z/ - output <text> message N lines (<count> times)
+> ruboty umec hoge 3
+hoge
+hoge
+hoge
+
+> ruboty umec hoge 5
+hoge
+hoge
+hoge
+hoge
+hoge
 
 ~~~
 
@@ -54,7 +78,6 @@ Or install it yourself as:
 
 |Name|Description|
 |:--|:--|
-|dependency1|dependency1 description|
 |dependency2|dependency2 description|
 
 ## Contributing

data/sample/Rubotyme

@@ -1,39 +1,64 @@
-# encoding: utf-8
-user_name "tbpgr"
-
-gem_class_name "Ume"
-gem_name "ume"
-
-title "An Ruboty Handler + Actions to output N line messages."
-
-env do |e|
-  e.name "ENV1"
-  e.description "ENV1 desc"
-end
-
-env do |e|
-  e.name "ENV2"
-  e.description "ENV2 desc"
-end
-
-dependency do |d|
-  d.name "dependency1"
-  d.description "dependency1 description"
-end
-
-dependency do |d|
-  d.name "dependency2"
-  d.description "dependency2 description"
-end
-
-command do |c|
-  c.name "ume"
-  c.pattern "/ume (?<count>.*?)\z/"
-  c.description "output empty message N lines (<count> times)"
-end
-
-command do |c|
-  c.name "umec"
-  c.pattern "/umec (?<text>.+?) (?<count>.*?)\z/"
-  c.description "output <text> message N lines (<count> times)"
-end
+# encoding: utf-8
+user_name "tbpgr"
+
+gem_class_name "Ume"
+gem_name "ume"
+
+title "An Ruboty Handler + Actions to output N line messages."
+
+env do |e|
+  e.name "ENV1"
+  e.description "ENV1 desc"
+end
+
+env do |e|
+  e.name "ENV2"
+  e.description "ENV2 desc"
+end
+
+dependency do |d|
+  d.name "dependency2"
+  d.description "dependency2 description"
+end
+
+command do |c|
+  c.name "ume"
+  c.pattern "/ume (?<count>.*?)\z/"
+  c.description "output empty message N lines (<count> times)"
+  c.example <<-EOS
+> ruboty help
+ruboty /ume (?<count>.*?)\z/               - output empty message N lines (<count> times)
+> ruboty ume 3
+.
+.
+.
+> ruboty ume 5
+.
+.
+.
+.
+.
+  EOS
+end
+
+command do |c|
+  c.name "umec"
+  c.pattern "/umec (?<text>.+?) (?<count>.*?)\z/"
+  c.description "output <text> message N lines (<count> times)"
+  c.example <<-EOS
+> ruboty help
+ruboty /umec (?<text>.+?) (?<count>.*?)\z/ - output <text> message N lines (<count> times)
+> ruboty umec hoge 3
+hoge
+hoge
+hoge
+
+> ruboty umec hoge 5
+hoge
+hoge
+hoge
+hoge
+hoge
+
+  EOS
+end

data/spec/ruboty/gen/readme_spec.rb

@@ -39,12 +39,20 @@ command do |c|
   c.name 'command1'
   c.pattern '/command1 | hoge/'
   c.description 'command1 description'
+  c.example <<-EOT
+example1_1
+example1_2
+  EOT
 end
 
 command do |c|
   c.name 'command2'
   c.pattern '/command2 | hoge/'
   c.description 'command2 description'
+  c.example <<-EOT
+example2_1
+example2_2
+  EOT
 end
       EOS
       template
@@ -90,14 +98,16 @@ Or install it yourself as:
 * command1 description
 
 ~~~
-
+example1_1
+example1_2
 ~~~
 
 ### command2
 * command2 description
 
 ~~~
-
+example2_1
+example2_2
 ~~~
 
 ## ENV

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboty-megen
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - tbpgr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor