ruboty-megen 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd9e3845a22ba4ba906e9b3bb805e77cd9201ad3
-  data.tar.gz: 6dd40f19d972f8adfcacb34a1847a2a4a3f8d34e
+  metadata.gz: 80435792af6109ec46237cc9b2a3ce2f7cf7c223
+  data.tar.gz: 2aa2cd6a156e691cdac79e3a702cbeb6ffc3b1b7
 SHA512:
-  metadata.gz: 61160373f68d4194112f616d568a78954bd0ff5f3572d59f1ac26f5f73930cbab293a200bfc6c8e96c510d6923b3e6f799c2b44a4f55d47cc936aa287181f4d3
-  data.tar.gz: 8c6dec855603d32473f6622196a6b1bc50f5cdb92113296d2f90724573be57cce4aa529fa61e0f5e2d5bb43f78e5c7b1a7291e87ecff0692c13d88e230baff53
+  metadata.gz: f168b4143afe14dc377f6398cdff1506a40524f96df2c820271548010e74202eba153c5bd3f5cf4415ef4762efe3d5fb81a42b24538eddda60c19362acc40541
+  data.tar.gz: 89905c3e731720778fa567cf46e736ee1c937da84c37015f99b1e3a8254b7120e1b9d6f9011dcddb432858fa5e92b2cdf9712e6c8516a59e8bc08d59f3be73f8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v.1.0.3
+2014/12/18
+
+### New Feature
+* Add emoji option that generate emoji headings
+
 ## v.1.0.2
 2014/12/10
 

data/README.md

@@ -8,7 +8,16 @@ Generate README.md for Ruboty Handler + Actions plugin.
 
 [Ruboty](https://github.com/r7kamura/ruboty) is Chat bot framework. Ruby + Bot = Ruboty
 
-## Installation
+## :notes: Image
+Rubotyme => README.md
+
+:tshirt::jeans::grey_question::grey_question::grey_question::tophat:  
+:tophat::mans_shoe::arrow_right::collision::arrow_right::man:  
+:man::grey_question::grey_question::grey_question::grey_question::tshirt:  
+:grey_question::grey_question::grey_question::grey_question::grey_question::jeans:  
+:grey_question::grey_question::grey_question::grey_question::grey_question::mans_shoe:  
+
+## :arrow_down: Installation
 
 Add this line to your application's Gemfile:
 
@@ -24,7 +33,7 @@ Or install it yourself as:
 
     $ gem install ruboty-megen
 
-## Rubotyme
+## :blue_book: Rubotyme
 ### Setting File Parameters
 
 |key|value|example|
@@ -42,7 +51,7 @@ Or install it yourself as:
 |commands/command description|Ruboty::Handler.on description|output empty message N lines (<count> times)|
 |commands/command example|Ruboty::Handler.on example|example usage|
 
-## Usage
+## :scroll: Usage
 ### init
 generate Rubotyme template file.
 
@@ -132,7 +141,22 @@ $ ruboty-megen generate
 
 [sample output ruboty-ume README](./sample/README.md)
 
-## Contributing
+### generate with emoji option
+generate Ruboty Handler + Action README.md template with emoji headings
+
+* edit Rubotyme file (previous case)
+
+* generate README
+
+~~~
+$ ruboty-megen generate --emoji
+~~~
+
+* output
+
+[sample output ruboty-ume README](./sample/README_emoji.md)
+
+## :two_men_holding_hands: Contributing :two_women_holding_hands:
 
 1. Fork it ( https://github.com/tbpgr/ruboty_megen/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/bin/ruboty-megen

@@ -1,31 +1,32 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
-
-require 'ruboty/gen'
-require 'ruboty/gen/version'
-require 'thor'
-
-module Ruboty
-  # = RubotyMegen CLI
-  class CLI < Thor
-    class_option :help, type: :boolean, aliases: '-h', desc: 'help message.'
-    class_option :version, type: :boolean, desc: 'version'
-
-    desc 'generate', 'Generate README.md template'
-    def generate
-      Ruboty::Gen::Readme.generate
-    end
-
-    desc 'init', 'generate Rubotyme template'
-    def init
-      Ruboty::Gen::Readme.init
-    end
-
-    desc 'version', 'version'
-    def version
-      p Ruboty::Gen::VERSION
-    end
-  end
-end
-
-Ruboty::CLI.start(ARGV)
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'ruboty/gen'
+require 'ruboty/gen/version'
+require 'thor'
+
+module Ruboty
+  # = RubotyMegen CLI
+  class CLI < Thor
+    class_option :help, type: :boolean, aliases: '-h', desc: 'help message.'
+    class_option :version, type: :boolean, desc: 'version'
+
+    desc 'generate', 'Generate README.md template'
+    option :emoji, type: :boolean, desc: 'Generate README.md template with emoji headings'
+    def generate
+      Ruboty::Gen::Readme.generate(options)
+    end
+
+    desc 'init', 'generate Rubotyme template'
+    def init
+      Ruboty::Gen::Readme.init
+    end
+
+    desc 'version', 'version'
+    def version
+      p Ruboty::Gen::VERSION
+    end
+  end
+end
+
+Ruboty::CLI.start(ARGV)

data/lib/ruboty/gen/readme.rb

@@ -135,6 +135,60 @@ Or install it yourself as:
 
 ## Contributing
 
+1. Fork it ( https://github.com/<%=user_name%>/ruboty-<%=gem_name%>/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+      EOS
+
+      RUBOTY_README_EMOJI_TEMPLATE = <<-EOS
+# Ruboty::<%=gem_class_name%>
+
+An Ruboty Handler + Actions to <%=title%>.
+
+[Ruboty](https://github.com/r7kamura/ruboty) is Chat bot framework. Ruby + Bot = Ruboty
+
+## :arrow_down: Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruboty-<%=gem_name%>'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruboty-<%=gem_name%>
+
+
+## :cl: Commands
+
+|Command|Pattern|Description|
+|:--|:--|:--|
+<%=command_table%>
+
+## :scroll: Usage
+<%=usages%>
+
+## :earth_asia: ENV
+
+|Name|Description|
+|:--|:--|
+<%=env_table%>
+
+## :couple: Dependency
+
+|Name|Description|
+|:--|:--|
+<%=dependency_table%>
+
+## :two_men_holding_hands: Contributing :two_women_holding_hands:
+
 1. Fork it ( https://github.com/<%=user_name%>/ruboty-<%=gem_name%>/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -150,11 +204,11 @@ Or install it yourself as:
       end
 
       # generate ruboty README.md template.
-      def self.generate
+      def self.generate(options = {})
         src = read_dsl
         dsl = Ruboty::Dsl.new
         dsl.instance_eval src
-        src = apply(dsl.ruboty_megen)
+        src = apply(dsl.ruboty_megen, options)
         File.open(README, 'w:utf-8') { |file|file.puts src }
       end
 
@@ -164,7 +218,7 @@ Or install it yourself as:
       private_class_method :read_dsl
 
       # rubocop:disable UselessAssignment
-      def self.apply(config)
+      def self.apply(config, options)
         gem_class_name = config.gem_class_name
         gem_name = config.gem_name
         title = config.title
@@ -174,7 +228,7 @@ Or install it yourself as:
         dependency_table = dependency_table(config.dependencies)
         user_name = config.user_name
 
-        erb = ERB.new(RUBOTY_README_TEMPLATE)
+        erb = ERB.new(choose_template(options))
         erb.result(binding)
       end
       private_class_method :apply
@@ -227,6 +281,11 @@ Or install it yourself as:
         texts.map { |e| e.gsub('|', '&#124;') }
       end
       private_class_method :normalize_markdown_table
+
+      def self.choose_template(options)
+        options[:emoji] ? RUBOTY_README_EMOJI_TEMPLATE : RUBOTY_README_TEMPLATE
+      end
+      private_class_method :choose_template
     end
   end
 end

data/lib/ruboty/gen/version.rb

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

data/sample/README_emoji.md

@@ -0,0 +1,89 @@
+# Ruboty::Ume
+
+An Ruboty Handler + Actions to An Ruboty Handler + Actions to output N line messages..
+
+[Ruboty](https://github.com/r7kamura/ruboty) is Chat bot framework. Ruby + Bot = Ruboty
+
+## :arrow_down: Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruboty-ume'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruboty-ume
+
+
+## :cl: Commands
+
+|Command|Pattern|Description|
+|:--|:--|:--|
+|[ume](#ume)|/ume (?<count>.*?)z/|output empty message N lines (<count> times)|
+|[umec](#umec)|/umec (?<text>.+?) (?<count>.*?)z/|output <text> message N lines (<count> times)|
+
+## :scroll: Usage
+### ume
+* 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
+
+~~~
+
+## :earth_asia: ENV
+
+|Name|Description|
+|:--|:--|
+|ENV1|ENV1 desc|
+|ENV2|ENV2 desc|
+
+## :couple: Dependency
+
+|Name|Description|
+|:--|:--|
+|dependency2|dependency2 description|
+
+## :two_men_holding_hands: Contributing :two_women_holding_hands:
+
+1. Fork it ( https://github.com/tbpgr/ruboty-ume/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/spec/ruboty/gen/readme_spec.rb

@@ -62,6 +62,7 @@ end
       {
         case_no: 1,
         case_title: 'valid case',
+        options: {},
         expected: <<-EOS
 # Ruboty::SampleGem
 
@@ -126,6 +127,81 @@ example2_2
 
 ## Contributing
 
+1. Fork it ( https://github.com/tbpgr/ruboty-sample_gem/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+        EOS
+      },
+      {
+        case_no: 1,
+        case_title: 'valid case',
+        options: { emoji: true },
+        expected: <<-EOS
+# Ruboty::SampleGem
+
+An Ruboty Handler + Actions to output sample messages.
+
+[Ruboty](https://github.com/r7kamura/ruboty) is Chat bot framework. Ruby + Bot = Ruboty
+
+## :arrow_down: Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruboty-sample_gem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruboty-sample_gem
+
+
+## :cl: Commands
+
+|Command|Pattern|Description|
+|:--|:--|:--|
+|[command1](#command1)|/command1 &#124; hoge/|command1 description|
+|[command2](#command2)|/command2 &#124; hoge/|command2 description|
+
+## :scroll: Usage
+### command1
+* command1 description
+
+~~~
+example1_1
+example1_2
+~~~
+
+### command2
+* command2 description
+
+~~~
+example2_1
+example2_2
+~~~
+
+## :earth_asia: ENV
+
+|Name|Description|
+|:--|:--|
+|ENV1|ENV1 description|
+|ENV2|ENV2 description|
+
+## :couple: Dependency
+
+|Name|Description|
+|:--|:--|
+|dependency1 name|dependency1 description|
+|dependency2 name|dependency2 description|
+
+## :two_men_holding_hands: Contributing :two_women_holding_hands:
+
 1. Fork it ( https://github.com/tbpgr/ruboty-sample_gem/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -144,7 +220,7 @@ example2_2
           # nothing
 
           # -- when --
-          Ruboty::Gen::Readme.generate
+          Ruboty::Gen::Readme.generate(c[:options])
           actual = File.open(Ruboty::Gen::Readme::README, 'r:utf-8') { |e|e.read }
 
           # -- then --

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboty-megen
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - tbpgr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -110,6 +110,7 @@ files:
 - lib/ruboty/models/env.rb
 - ruboty-megen.gemspec
 - sample/README.md
+- sample/README_emoji.md
 - sample/Rubotyme
 - spec/ruboty/gen/readme_spec.rb
 - spec/spec_helper.rb