dslable 0.0.1 → 0.0.2

data/README.md

@@ -5,6 +5,7 @@ Dslable is generator for simple spec gem.
 ## Summary
 * create gem template with DslSettingFile.
 * you can get bin-executable gem.
+* you can gem creation workflow.
 * generated gem has 1-DslSettingFile.
 * generated gem has 1-core logic class.
 * generated gem has 1-dsl class.
@@ -84,6 +85,7 @@ Or install it yourself as:
 ~~~bash
 1 2 fizz 3 4 buzz 5 fizz 7 8 fizz buzz 11 fizz 13 14 fizzbuzz
 ~~~
+
 * you can choose output 'fizz/buzz/fizzbuzz' or 'FIZZ/BUZZ/FIZZBUZZ' by setting file.
 * you can set fizzbuzz range by setting file.
 
@@ -186,9 +188,13 @@ fizz_buzz_gem
 │  └─fizz_buzz_gem
 │          version.rb
 │
-└─spec
-        fizz_buzz_gem_core_spec.rb
-        spec_helper.rb
+├─spec
+│      fizz_buzz_gem_core_spec.rb
+│      spec_helper.rb
+└─tudu
+        todos
+        doings
+        dones
 ~~~
 
 Gemfile Template
@@ -434,6 +440,35 @@ describe FizzBuzzGem::Core do
 end
 ~~~
 
+Workflow Template(tudu/todos, tudu/doings, tudu/dones). you can check by tudu gem.
+~~~bash
+$ tudu tasks -c
+========TODOS========
+implement 'fizz_buzz_gem_core.rb' your main logic. pass rspec all specs.
+implement bin 'bin/your_bin'.
+edit 'fizz_buzz_gem.gemspec'.
+edit 'README.md'.
+edit 'LICENSE.txt'.
+git add, commit.
+rake install.
+check gem(test using).
+gem uninstall fizz_buzz_gem.
+rake release.
+gem install fizz_buzz_gem.
+after release check.
+
+========DOINGS========
+implement 'fizz_buzz_gem_core_spec.rb'.
+
+========DONES========
+~~~
+
+### Steps: check todo by tudu now
+~~~bash
+$ tudu now
+implement 'fizz_buzz_gem_core_spec.rb'.
+~~~
+
 ### Steps: implement 'fizz_buzz_core_spec.rb' manually. (TDD step)
 ~~~ruby
 # encoding: utf-8
@@ -582,6 +617,13 @@ rspec ./spec/fizz_buzz_gem_core_spec.rb:75 # FizzBuzzGem::Core execute |case_no=
 Randomized with seed 63051
 ~~~
 
+### Steps: after implement spec, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+implement 'fizz_buzz_gem_core.rb' your main logic. pass rspec all specs.
+~~~
+
 ### Steps: implement 'fizz_buzz_core.rb' manually.
 ~~~ruby
 # encoding: utf-8
@@ -659,37 +701,11 @@ Finished in 0.011 seconds
 Randomized with seed 29906
 ~~~
 
-### Steps: Edit fizz_buzz_gem.gemspec manually
-~~~ruby
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fizz_buzz_gem/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "fizz_buzz_gem"
-  spec.version       = FizzBuzzGem::VERSION
-  spec.authors       = ["yourname"]
-  spec.email         = ["your@mail.address"]
-  spec.description   = %q{fizz buzz gem}
-  spec.summary       = %q{fizz buzz gem}
-  spec.homepage      = ""
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "thor", "~> 0.18.1"
-  spec.add_runtime_dependency "activesupport", "~> 4.0.1"
-  spec.add_runtime_dependency "activemodel", "~> 4.0.2"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.14.1"
-  spec.add_development_dependency "simplecov", "~> 0.8.2"
-end
+### Steps: after implement core.rb, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+implement bin 'bin/your_bin'.
 ~~~
 
 ### Steps: Edit bin bin/fizzbuzzgem manually
@@ -727,6 +743,53 @@ end
 FizzBuzzGem::CLI.start(ARGV)
 ~~~
 
+### Steps: after implement bin, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+edit 'fizz_buzz_gem.gemspec'.
+~~~
+
+### Steps: Edit fizz_buzz_gem.gemspec manually
+~~~ruby
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fizz_buzz_gem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fizz_buzz_gem"
+  spec.version       = FizzBuzzGem::VERSION
+  spec.authors       = ["yourname"]
+  spec.email         = ["your@mail.address"]
+  spec.description   = %q{fizz buzz gem}
+  spec.summary       = %q{fizz buzz gem}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor", "~> 0.18.1"
+  spec.add_runtime_dependency "activesupport", "~> 4.0.1"
+  spec.add_runtime_dependency "activemodel", "~> 4.0.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "simplecov", "~> 0.8.2"
+end
+~~~
+
+### Steps: after edit gemspec, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+edit 'README.md'.
+~~~
+
 ### Steps: Edit README.md manually
 ~~~ruby
 # FizzBuzzGem
@@ -760,6 +823,23 @@ usage...
 5. Create new Pull Request
 ~~~
 
+### Steps: after edit README.md, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+edit 'LICENSE.txt'.
+~~~
+
+### Steps: Edit LICENSE.txt
+edit.
+
+### Steps: after edit LICENSE.txt, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+git add, commit.
+~~~
+
 ### Steps: git add, commit
 ~~~bash
 $ git add -A
@@ -767,6 +847,13 @@ $ git add -u
 $ git commit -m "first commit"
 ~~~
 
+### Steps: after git add/commit, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+rake install.
+~~~
+
 ### Steps: rake install
 ~~~bash
 $ rake install
@@ -774,6 +861,13 @@ fizz_buzz_gem 0.0.1 built to pkg/fizz_buzz_gem-0.0.1.gem.
 fizz_buzz_gem (0.0.1) installed.
 ~~~
 
+### Steps: after rake install, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+check gem(test using).
+~~~
+
 ### Steps: test use fizzbuzzgem
 show help
 ~~~bash
@@ -834,17 +928,66 @@ $ fizzbuzzgem e
 1 2 fizz 4 buzz fizz 7 8 fizz buzz 11 fizz 13 14 fizzbuzz
 ~~~
 
+### Steps: after test using, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+gem uninstall fizz_buzz_gem.
+~~~
+
+### Steps: uninstall test installed gem.
+~~~bash
+gem uninstall fizz_buzz_gem
+~~~
+
+### Steps: after gem uninstall fizz_buzz_gem, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+rake release.
+~~~
+
 ### Steps: if test using is ok, release gem to RubyGems
-~~~csh
+~~~bash
 $ rake release
 ~~~
 
+### Steps: after rake release, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+gem install fizz_buzz_gem.
+~~~
+
+### Steps: install gem
+~~~bash
+$ gem install fizz_buzz_gem
+~~~
+
+### Steps: after gem install fizz_buzz_gem, execute 'tudu done'. and confirm next todo by 'todo now'
+~~~bash
+$ tudu done
+$ tudu now
+after release check.
+~~~
+
+### Steps: check your gem.
+check.
+
+### Steps: after check your gem complete, execute 'tudu done'. all todo complete'
+~~~bash
+$ tudu done
+All Tasks Finish!!
+~~~
+
 ## Notes
 * this gem uses 'bundle gem' command to create gem template. (bundler gem).
 * this gem uses 'rspec --init' command to create RSpec template (rspec gem).
 * this gem uses 'piccolo' command to create RSpec spec template (rspec_piccolo gem).
+* this gem uses 'tudu' command to create Workflow (tudu gem).
 
 ## History
+* version 0.0.2 : add workflow generation by 'tudu gem'.
 * version 0.0.1 : first release.
 
 ## Contributing

data/lib/dslable/version.rb

@@ -1,3 +1,3 @@
 module Dslable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/dslable_core.rb

@@ -3,6 +3,7 @@ require "dslable_field"
 require "dslable_args"
 require "dslable_dsl"
 require "generators/gem_template"
+require "generators/workflow"
 require "generators/product_codes/cli"
 require "generators/product_codes/core"
 require "generators/product_codes/dsl"
@@ -62,6 +63,7 @@ end
       dsl.instance_eval src
       Dslable::Generators::GemTemplate.new(dsl).generate
       Dslable::Generators::Settings::Gemfile.new(dsl).generate
+      Dslable::Generators::Workflow.new(dsl).generate
       Dslable::Generators::ProductCodes::Core.new(dsl).generate
       Dslable::Generators::ProductCodes::Dsl.new(dsl).generate
       Dslable::Generators::ProductCodes::DslModel.new(dsl).generate

data/lib/generators/settings/gemfile.rb

@@ -13,6 +13,7 @@ gem "thor", "~> 0.18.1"
 gem "simplecov", "~> 0.8.2"
 gem "activesupport", "~> 4.0.1"
 gem "activemodel", "~> 4.0.2"
+gem "tudu", "~> 0.0.4"
     EOF
 
     attr_accessor :dsl

data/lib/generators/workflow.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+require 'generators/generators'
+require 'fileutils'
+require 'dslable_dsl'
+require 'erb'
+
+module Dslable::Generators
+  # =Dslable::Generators Gem Template Generator
+  class Workflow
+    # ==todos contents
+    TODOS_CONTENTS = <<-EOS
+implement '<%=gem_name%>_core.rb' your main logic. pass rspec all specs.
+implement bin 'bin/<%=bin_name%>'.
+edit '<%=gem_name%>.gemspec'.
+edit 'README.md'.
+edit 'LICENSE.txt'.
+git add, commit.
+rake install.
+check gem(test using).
+gem uninstall <%=gem_name%>.
+rake release.
+gem install <%=gem_name%>.
+after release check.
+    EOS
+
+    # ==doings contents
+    DOINGS_CONTENTS = <<-EOS
+implement '<%=gem_name%>_core_spec.rb'.
+    EOS
+
+    # ==tudu file definitions
+    TUDU_FILES = {
+      :todos => {
+        :file_name => 'tudu/todos',
+        :contents => TODOS_CONTENTS
+      },
+      :doings => {
+        :file_name => 'tudu/doings',
+        :contents => DOINGS_CONTENTS
+      },
+      :dones => {
+        :file_name => 'tudu/dones',
+        :contents => ''
+      },
+    }
+    attr_accessor :dsl
+
+    #== initialize generate gem template
+    #=== Params
+    #- _dsl: input from dsl
+    def initialize(_dsl)
+      raise InvalidDslError.new('dsl not allow nil') if _dsl.nil?
+      @dsl = _dsl
+    end
+
+    #== generate gem template
+    def generate
+      Dir.mkdir('tudu')
+      gem_name = @dsl._gem_name
+      bin_name = @dsl._bin_name
+      TUDU_FILES.each do |key, file_definition|
+        File.open("./#{file_definition[:file_name]}", "w") do |f|
+          f.print adapt_template(gem_name, bin_name, file_definition[:contents])
+        end
+      end
+    end
+
+    private
+
+    def adapt_template(gem_name, bin_name, template)
+      erb = ERB.new(template)
+      erb.result(binding)
+    end
+  end
+  class InvalidDslError < StandardError;end
+end

data/spec/generators/workflow_spec.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'generators/workflow'
+
+describe Dslable::Generators::Workflow do
+
+  context :generate do
+    OUTPUT_WORKFLOW_TMP_DIR = "workflow_tmp"
+    TODOS_CASE1 =<<-EOS
+implement 'sample_gem_core.rb' your main logic. pass rspec all specs.
+implement bin 'bin/samplegem'.
+edit 'sample_gem.gemspec'.
+edit 'README.md'.
+edit 'LICENSE.txt'.
+git add, commit.
+rake install.
+check gem(test using).
+gem uninstall sample_gem.
+rake release.
+gem install sample_gem.
+after release check.
+    EOS
+
+    DOINGS_CASE1 =<<-EOS
+implement 'sample_gem_core_spec.rb'.
+    EOS
+
+    cases = [
+      {
+        case_no: 1,
+        case_title: "generate",
+        gem_name: "sample_gem",
+        bin_name: "samplegem",
+        expected: Dslable::Generators::Workflow::TUDU_FILES,
+        expected_contents: {
+          :todos => TODOS_CASE1,
+          :doings => DOINGS_CASE1,
+          :dones => ""
+        }
+      },
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          dsl = Dslable::Dsl.new
+          dsl.gem_name c[:gem_name]
+          dsl.bin_name c[:bin_name]
+          workflow = Dslable::Generators::Workflow.new(dsl)
+
+          # -- when --
+          workflow.generate
+
+          # -- then --
+          c[:expected].each do |key, file_definition|
+            actual = File.open(file_definition[:file_name]) {|f|f.read}
+            expect(actual).to eq(c[:expected_contents][key])
+          end
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+        Dir.mkdir(OUTPUT_WORKFLOW_TMP_DIR) unless Dir.exists? OUTPUT_WORKFLOW_TMP_DIR
+        Dir.chdir(OUTPUT_WORKFLOW_TMP_DIR)
+      end
+
+      def case_after(c)
+        # implement each case after
+        Dir.chdir("../")
+        FileUtils.rm_rf(OUTPUT_WORKFLOW_TMP_DIR) if Dir.exists? OUTPUT_WORKFLOW_TMP_DIR
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dslable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-22 00:00:00.000000000 Z
+date: 2013-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &21204576 !ruby/object:Gem::Requirement
+  requirement: &20762268 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.18.1
   type: :runtime
   prerelease: false
-  version_requirements: *21204576
+  version_requirements: *20762268
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &21213348 !ruby/object:Gem::Requirement
+  requirement: &20761524 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 4.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *21213348
+  version_requirements: *20761524
 - !ruby/object:Gem::Dependency
   name: rspec_piccolo
-  requirement: &21212700 !ruby/object:Gem::Requirement
+  requirement: &20776596 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *21212700
+  version_requirements: *20776596
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &21210648 !ruby/object:Gem::Requirement
+  requirement: &20776104 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *21210648
+  version_requirements: *20776104
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21223656 !ruby/object:Gem::Requirement
+  requirement: &20775660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.14.1
   type: :runtime
   prerelease: false
-  version_requirements: *21223656
+  version_requirements: *20775660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21219780 !ruby/object:Gem::Requirement
+  requirement: &20775168 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21219780
+  version_requirements: *20775168
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &21216972 !ruby/object:Gem::Requirement
+  requirement: &20774232 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *21216972
+  version_requirements: *20774232
 description: Dslable is generator for simple gem-code template.
 email:
 - tbpgr@tbpgr.jp
@@ -118,6 +118,7 @@ files:
 - lib/generators/rspec/spec_template.rb
 - lib/generators/rspec/specs.rb
 - lib/generators/settings/gemfile.rb
+- lib/generators/workflow.rb
 - spec/dslable_args_spec.rb
 - spec/dslable_core_spec.rb
 - spec/dslable_dsl_spec.rb
@@ -130,6 +131,7 @@ files:
 - spec/generators/rspec/spec_template_spec.rb
 - spec/generators/rspec/specs_spec.rb
 - spec/generators/settings/gemfile_spec.rb
+- spec/generators/workflow_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/tbpgr/dslable
 licenses:
@@ -169,5 +171,6 @@ test_files:
 - spec/generators/rspec/spec_template_spec.rb
 - spec/generators/rspec/specs_spec.rb
 - spec/generators/settings/gemfile_spec.rb
+- spec/generators/workflow_spec.rb
 - spec/spec_helper.rb
 has_rdoc: