rspec-kickstarter 0.0.9 → 0.1.0

data/bin/rspec-kickstarter

@@ -12,8 +12,8 @@ spec_dir = './spec'
 
 opt = OptionParser.new
 opt.on('-f', 'Create if absent or append to the existing spec') { |_| force_write = true }
-opt.on('-n', 'Dry run mode') { |_| dry_run = true }
-opt.on('-o VAL', 'Output directory') { |dir| spec_dir = dir }
+opt.on('-n', 'Dry run mode (shows generated code to console)') { |_| dry_run = true }
+opt.on('-o VAL', 'Output directory Output directory (default: ./spec)') { |dir| spec_dir = dir }
 
 args = opt.parse(ARGV)
 dir_or_file = args.first

data/lib/rspec_kickstarter/generator.rb

@@ -4,128 +4,39 @@ require 'rdoc'
 require 'rdoc/parser/ruby'
 require 'rdoc/options'
 require 'rdoc/stats'
+require 'rspec_kickstarter'
 
-module RSpecKickstarter
-  class Generator
+class RSpecKickstarter::Generator
 
-    attr_accessor :spec_dir
+  attr_accessor :spec_dir
 
-    def initialize(spec_dir = './spec')
-      @spec_dir = spec_dir.gsub(/\/$/, '')
-    end
-
-    def get_target(top_level)
-      c = top_level.classes.first
-      if c.nil?
-        m = top_level.modules.first
-        if m.nil?
-          top_level.is_a?(RDoc::NormalModule) ? top_level : nil
-        else
-          get_target(m)
-        end
-      else
-        c
-      end
-    end
-
-    def get_complete_class_name(c, name = c.name)
-      if !c.parent.name.nil? && c.parent.is_a?(RDoc::NormalModule)
-        get_complete_class_name(c.parent, "#{c.parent.name}::#{name}")
-      else
-        name
-      end
-    end
-
-    def instance_name(c)
-      c.name.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
-        downcase
-    end
-
-    def to_param_names_array(params)
-      params.split(',').map { |p| p.gsub(/[\(\)\s]/, '').gsub(/=.+$/, '') }.reject { |p| p.nil? || p.empty? }
-    end
-
-    def get_params_initialization_code(method)
-      code = to_param_names_array(method.params).map { |p| "      #{p} = stub('#{p}')" }.join("\n")
-      code.empty? ? "" : "\n#{code}"
-    end
-
-    def get_instantiation_code(c, method)
-      if method.singleton
-        ""
-      else
-        constructor = c.method_list.find { |m| m.name == 'new' }
-        if constructor.nil?
-          "\n      #{instance_name(c)} = #{get_complete_class_name(c)}.new"
-        else
-          get_params_initialization_code(constructor) +
-              "\n      #{instance_name(c)} = #{get_complete_class_name(c)}.new(#{to_param_names_array(constructor.params).join(', ')})"
-        end
-      end
-    end
-
-    def get_method_invocation_code(c, method)
-      if method.singleton
-        "#{get_complete_class_name(c)}.#{method.name}(#{to_param_names_array(method.params).join(', ')})#{get_block_code(method)}"
-      else
-        "#{instance_name(c)}.#{method.name}(#{to_param_names_array(method.params).join(', ')})#{get_block_code(method)}"
-      end
-    end
-
-    def get_block_code(method)
-      if method.block_params.nil? || method.block_params.empty?
-        ""
-      else
-        " { |#{method.block_params}| }"
-      end
-    end
+  def initialize(spec_dir = './spec')
+    @spec_dir = spec_dir.gsub(/\/$/, '')
+  end
 
-    def write_spec(file_path, force_write = false, dry_run = false)
+  def write_spec(file_path, force_write = false, dry_run = false)
 
-      body = File.read(file_path)
+    top_level = get_ruby_parser(file_path).scan
+    c = extract_target_class_or_module(top_level)
 
-      top_level = RDoc::TopLevel.new(file_path)
-      if RUBY_VERSION.to_f < 2.0
-        # reset is removed since 2.0
-        RDoc::TopLevel.reset()
-      end
+    if c.nil?
+      puts "#{file_path} skipped (Class/Module not found)."
+    else
 
-      # RDoc::Stats initialization
-      if RUBY_VERSION.to_f >= 2.0
-        # Ruby 2.0 requires RDoc::Store internally.
-        store = RDoc::Store.new
-        top_level.store = store
-        stats = RDoc::Stats.new(store, 1)
-      else
-        stats = RDoc::Stats.new(1)
-      end
+      spec_path = get_spec_path(file_path)
 
-      parser = RDoc::Parser::Ruby.new(
-        top_level,
-        file_path,
-        body,
-        RDoc::Options.new,
-        stats
-      )
-      top_level = parser.scan
-      c = get_target(top_level)
-
-      if c.nil?
-        puts "#{file_path} skipped (Class/Module not found)."
-      else
+      if force_write && File.exist?(spec_path)
+        # Append to the existing spec or skip
 
-        spec_path = spec_dir + '/' + file_path.gsub(/^(lib\/)|(app\/)/, '').gsub(/\.rb$/, '_spec.rb')
+        existing_spec = File.read(spec_path)
+        racking_methods = c.method_list
+          .select { |m| m.visibility == :public }
+          .reject { |m| existing_spec.match(m.name) }
 
-        if force_write && File.exist?(spec_path)
-          existing_spec = File.read(spec_path)
-          racking_methods = c.method_list.select { |m| m.visibility == :public }.reject { |m| existing_spec.match(m.name) }
-          if racking_methods.empty? 
-            puts "#{spec_path} skipped."
-          else
-            additional_spec = <<SPEC
+        if racking_methods.empty? 
+          puts "#{spec_path} skipped."
+        else
+          additional_spec = <<SPEC
 #{racking_methods.map { |method|
   <<EACH_SPEC
   # TODO auto-generated
@@ -138,34 +49,38 @@ module RSpecKickstarter
 EACH_SPEC
 }.join("\n")}
 SPEC
-            last_end_not_found = true
-            code = existing_spec.split("\n").reverse.reject { |line| 
-              if last_end_not_found 
-                last_end_not_found = line.gsub(/#.+$/, '').strip != "end"
-                true
-              else
-                false
-              end
-            }.reverse.join("\n") + "\n" + additional_spec + "\nend\n"
-            if dry_run
-              puts "----- #{spec_path} -----"
-              puts code
+          last_end_not_found = true
+          code = existing_spec.split("\n").reverse.reject { |line| 
+            if last_end_not_found 
+              last_end_not_found = line.gsub(/#.+$/, '').strip != "end"
+              true
             else
-              File.open(spec_path, 'w') { |f| f.write(code) }
+              false
             end
-            puts "#{spec_path} modified."
+          }.reverse.join("\n") + "\n" + additional_spec + "\nend\n"
+          if dry_run
+            puts "----- #{spec_path} -----"
+            puts code
+          else
+            File.open(spec_path, 'w') { |f| f.write(code) }
           end
+          puts "#{spec_path} modified."
+        end
 
-        else
-          self_path = file_path.gsub(/^(lib\/)|(app\/)/, '').gsub(/\.rb$/, '')
-          code = <<SPEC
+      else
+        # Create a new spec 
+
+        self_path = to_string_value_to_require(file_path)
+        code = <<SPEC
 # -*- encoding: utf-8 -*-
 require 'spec_helper'
 require '#{self_path}'
 
 describe #{get_complete_class_name(c)} do
 
-#{c.method_list.select { |m| m.visibility == :public }.map { |method|
+#{c.method_list
+  .select { |m| m.visibility == :public }
+  .map { |method| 
   <<EACH_SPEC
   # TODO auto-generated
   describe '#{method.name}' do
@@ -178,24 +93,173 @@ EACH_SPEC
 }.join("\n")}
 end
 SPEC
-
-          if dry_run
-            puts "----- #{spec_path} -----"
-            puts code
+        if dry_run
+          puts "----- #{spec_path} -----"
+          puts code
+        else
+          if File.exist?(spec_path)
+            puts "#{spec_path} already exists."
           else
-            if File.exist?(spec_path)
-              puts "#{spec_path} already exists."
-            else
-              FileUtils.mkdir_p(File.dirname(spec_path))
-              File.open(spec_path, 'w') { |f| f.write(code) }
-              puts "#{spec_path} created."
-            end
+            FileUtils.mkdir_p(File.dirname(spec_path))
+            File.open(spec_path, 'w') { |f| f.write(code) }
+            puts "#{spec_path} created."
           end
         end
       end
+    end
+
+  end
+
+  #
+  # Creates new RDoc::Parser::Ruby instance.
+  #
+  def get_ruby_parser(file_path)
+    top_level = RDoc::TopLevel.new(file_path)
+    if RUBY_VERSION.to_f < 2.0
+      # reset is removed since 2.0
+      RDoc::TopLevel.reset()
+    end
+
+    # RDoc::Stats initialization
+    if RUBY_VERSION.to_f >= 2.0
+      # Ruby 2.0 requires RDoc::Store internally.
+      store = RDoc::Store.new
+      top_level.store = store
+      stats = RDoc::Stats.new(store, 1)
+    else
+      stats = RDoc::Stats.new(1)
+    end
+
+    RDoc::Parser::Ruby.new(
+      top_level,
+      file_path,
+      File.read(file_path),
+      RDoc::Options.new,
+      stats
+    )
+  end
+
+  #
+  # Extracts RDoc::NormalClass/RDoc::NormalModule from RDoc::TopLevel.
+  #
+  def extract_target_class_or_module(top_level)
+    c = top_level.classes.first
+    if c.nil?
+      m = top_level.modules.first
+      if m.nil?
+        top_level.is_a?(RDoc::NormalModule) ? top_level : nil
+      else
+        extract_target_class_or_module(m)
+      end
+    else
+      c
+    end
+  end
+
+  #
+  # Gets the complete class name from RDoc::NormalClass/RDoc::NormalModule instance.
+  #
+  def get_complete_class_name(c, name = c.name)
+    if !c.parent.name.nil? && c.parent.is_a?(RDoc::NormalModule)
+      get_complete_class_name(c.parent, "#{c.parent.name}::#{name}")
+    else
+      name
+    end
+  end
+
+  #
+  # Returns spec file path.
+  # e.g. "lib/foo/bar_baz.rb" -> "spec/foo/bar_baz_spec.rb"
+  #
+  def get_spec_path(file_path)
+    spec_dir + '/' + file_path.gsub(/^\.\//, '').gsub(/^(lib\/)|(app\/)/, '').gsub(/\.rb$/, '_spec.rb')
+  end
+
+  #
+  # Returns string value to require.
+  # e.g. "lib/foo/bar_baz.rb" -> "foo/bar_baz"
+  #
+  def to_string_value_to_require(file_path)
+    file_path.gsub(/^(lib\/)|(app\/)/, '').gsub(/\.rb$/, '')
+  end
+
+  # 
+  # Returns snake_case name.
+  # e.g. FooBar -> "foo_bar"
+  #
+  def instance_name(c)
+    c.name
+      .gsub(/::/, '/')
+      .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+      .tr("-", "_")
+      .downcase
+  end
+
+  #
+  # Extracts parameter names as an *Array*.
+  # e.g. "()" -> []
+  # e.g. "(a, b = 'foo')" -> ["a", "b"]
+  #
+  def to_param_names_array(params)
+    params.split(',').map { |p| p.gsub(/[\(\)\s]/, '').gsub(/=.+$/, '') }.reject { |p| p.nil? || p.empty? }
+  end
+
+  # 
+  # Code generation
+  #
+
+  #
+  # e.g.
+  #     a = stub('a')
+  #     b = stub('b')
+  #     bar_baz = BarBaz.new(a, b)
+  #
+  def get_instantiation_code(c, method)
+    if method.singleton
+      ""
+    else
+      constructor = c.method_list.find { |m| m.name == 'new' }
+      if constructor.nil?
+        "\n      #{instance_name(c)} = #{get_complete_class_name(c)}.new"
+      else
+        get_params_initialization_code(constructor) +
+          "\n      #{instance_name(c)} = #{get_complete_class_name(c)}.new(#{to_param_names_array(constructor.params).join(', ')})"
+      end
+    end
+  end
 
+  #
+  # e.g.
+  #     a = stub('a')
+  #     b = stub('b')
+  #
+  def get_params_initialization_code(method)
+    code = to_param_names_array(method.params).map { |p| "      #{p} = stub('#{p}')" }.join("\n")
+    code.empty? ? "" : "\n#{code}"
+  end
+
+  #
+  # e.g. BarBaz.do_something(a, b) { |c| }
+  #
+  def get_method_invocation_code(c, method)
+    if method.singleton
+      "#{get_complete_class_name(c)}.#{method.name}(#{to_param_names_array(method.params).join(', ')})#{get_block_code(method)}"
+    else
+      "#{instance_name(c)}.#{method.name}(#{to_param_names_array(method.params).join(', ')})#{get_block_code(method)}"
     end
+  end
 
+  #
+  # e.g. { |a, b| }
+  #
+  def get_block_code(method)
+    if method.block_params.nil? || method.block_params.empty?
+      ""
+    else
+      " { |#{method.block_params}| }"
+    end
   end
+
 end
 

data/lib/rspec_kickstarter/version.rb

@@ -1,3 +1,3 @@
 module RSpecKickstarter
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/lib/rspec_kickstarter.rb

@@ -1,7 +1,14 @@
 # -*- encoding: utf-8 -*-
 
+require "rspec_kickstarter/generator"
 require "rspec_kickstarter/version"
 
 module RSpecKickstarter
+
+  def self.write_spec(file_path, spec_dir, force_write = false, dry_run = false)
+    generator = RSpecKickstarter::Generator.new(spec_dir)
+    generator.write_spec(file_path, force_write, dry_run)
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-kickstarter
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,13 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-26 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies: []
-description: RSpec kickstarter generates spec files for existing code.
+description: rspec-kickstarter supports you writing tests for existing code.
 email:
-- - seratch@gmail.com
-- - MIT
-- RSpec kickstarter generates spec files for existing code.
+- seratch@gmail.com
 executables:
 - rspec-kickstarter
 extensions: []
@@ -49,5 +47,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: RSpec kickstarter generates spec files for existing code.
+summary: rspec-kickstarter supports you writing tests for existing code.
 test_files: []