rspec-kickstarter 0.2.6 → 0.2.7

data/lib/rspec_kickstarter.rb

@@ -3,6 +3,9 @@
 require "rspec_kickstarter/generator"
 require "rspec_kickstarter/version"
 
+#
+# RSpecKickstarter Facade
+#
 module RSpecKickstarter
 
   def self.write_spec(file_path, spec_dir = './spec', force_write = false, dry_run = false)

data/lib/rspec_kickstarter/erb_factory.rb

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+
+require 'erb'
+require 'rspec_kickstarter'
+require 'rspec_kickstarter/erb_templates'
+
+#
+# ERB instance provider
+#
+class RSpecKickstarter::ERBFactory
+
+  def initialize(custom_template)
+   @custom_template = custom_template
+  end
+
+  #
+  # Returns ERB instance for creating new spec
+  #
+  def get_instance_for_new_spec(rails_mode, target_path)
+    ERB.new(get_erb_template(@custom_template, true, rails_mode, target_path), nil, '-', '_new_spec_code')
+  end
+
+  #
+  # Returns ERB instance for appeding lacking tests
+  #
+  def get_instance_for_appending(rails_mode, target_path)
+    ERB.new(get_erb_template(@custom_template, false, rails_mode, target_path), nil, '-', '_additional_spec_code')
+  end
+
+  private
+
+  #
+  # Returns ERB template
+  #
+  def get_erb_template(custom_template, is_full, rails_mode, target_path)
+    if custom_template
+      custom_template
+    elsif rails_mode && target_path.match(/controllers/)
+      if is_full then RSpecKickstarter::ERBTemplates::RAILS_CONTROLLER_NEW_SPEC_TEMPLATE 
+      else            RSpecKickstarter::ERBTemplates::RAILS_CONTROLLER_METHODS_PART_TEMPLATE
+      end
+    elsif rails_mode && target_path.match(/helpers/)
+      if is_full then RSpecKickstarter::ERBTemplates::RAILS_HELPER_NEW_SPEC_TEMPLATE 
+      else            RSpecKickstarter::ERBTemplates::RAILS_HELPER_METHODS_PART_TEMPLATE
+      end
+    else
+      if is_full then RSpecKickstarter::ERBTemplates::BASIC_NEW_SPEC_TEMPLATE 
+      else            RSpecKickstarter::ERBTemplates::BASIC_METHODS_PART_TEMPLATE
+      end
+    end
+  end
+
+end

data/lib/rspec_kickstarter/erb_templates.rb

@@ -0,0 +1,81 @@
+# -*- encoding: utf-8 -*-
+
+require 'erb'
+require 'rspec_kickstarter'
+
+#
+# ERB templates
+#
+module RSpecKickstarter::ERBTemplates
+
+  BASIC_METHODS_PART_TEMPLATE = <<SPEC
+<%- methods_to_generate.map { |method| %>
+  # TODO auto-generated
+  describe '#<%= method.name %>' do
+    it 'works' do
+<%- unless get_instantiation_code(c, method).nil?      -%><%= get_instantiation_code(c, method) %><%- end -%>
+<%- unless get_params_initialization_code(method).nil? -%><%= get_params_initialization_code(method) %><%- end -%>
+      result = <%= get_method_invocation_code(c, method) %>
+      expect(result).not_to be_nil
+    end
+  end
+<% } %>
+SPEC
+
+  BASIC_NEW_SPEC_TEMPLATE = <<SPEC
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+<% unless rails_mode then %>require '<%= self_path %>'
+<% end -%>
+
+describe <%= get_complete_class_name(c) %> do
+<%= ERB.new(BASIC_METHODS_PART_TEMPLATE, nil, '-').result(binding) -%>
+end
+SPEC
+
+  RAILS_CONTROLLER_METHODS_PART_TEMPLATE = <<SPEC
+<%- methods_to_generate.map { |method| %>
+  # TODO auto-generated
+  describe '<%= get_rails_http_method(method.name).upcase %> <%= method.name %>' do
+    it 'works' do
+      <%= get_rails_http_method(method.name) %> :<%= method.name %>, {}, {}
+      expect(response.status).to eq(200)
+    end
+  end
+<% } %>
+SPEC
+
+  RAILS_CONTROLLER_NEW_SPEC_TEMPLATE = <<SPEC
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe <%= get_complete_class_name(c) %> do
+<%= ERB.new(RAILS_CONTROLLER_METHODS_PART_TEMPLATE, nil, '-').result(binding) -%>
+end
+SPEC
+
+  RAILS_HELPER_METHODS_PART_TEMPLATE = <<SPEC
+<%- methods_to_generate.map { |method| %>
+  # TODO auto-generated
+  describe '#<%= method.name %>' do
+    it 'works' do
+      result = <%= get_rails_helper_method_invocation_code(method) %>
+      expect(result).not_to be_nil
+    end
+  end
+<% } %>
+SPEC
+
+  RAILS_HELPER_NEW_SPEC_TEMPLATE = <<SPEC
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe <%= get_complete_class_name(c) %> do
+<%= ERB.new(RAILS_HELPER_METHODS_PART_TEMPLATE, nil, '-').result(binding) -%>
+end
+SPEC
+
+end

data/lib/rspec_kickstarter/generator.rb

@@ -1,14 +1,16 @@
 # -*- encoding: utf-8 -*-
 
-require 'erb'
 require 'rdoc'
-require 'rdoc/generator'
-require 'rdoc/options'
-require 'rdoc/parser/ruby'
-require 'rdoc/stats'
 require 'rspec_kickstarter'
+require 'rspec_kickstarter/erb_factory'
+require 'rspec_kickstarter/erb_templates'
+require 'rspec_kickstarter/rdoc_factory'
 
+#
+# RSpec Code Generator
+#
 class RSpecKickstarter::Generator
+  include RSpecKickstarter::ERBTemplates
 
   attr_accessor :spec_dir, :delta_template, :full_template
 
@@ -18,126 +20,29 @@ class RSpecKickstarter::Generator
     @full_template = full_template
   end
 
+  #
+  # Writes new spec or appends to the existing spec.
+  #
   def write_spec(file_path, force_write = false, dry_run = false, rails_mode = false)
-
-    top_level = get_ruby_parser(file_path).scan
-    c = extract_target_class_or_module(top_level)
-
-    if c.nil?
-      puts "#{file_path} skipped (Class/Module not found)."
-    else
-
+    class_or_module = RSpecKickstarter::RDocFactory::get_rdoc_class_or_module(file_path)
+    if class_or_module
       spec_path = get_spec_path(file_path)
-
       if force_write && File.exist?(spec_path)
-        # Append to the existing spec or skip
-
-        existing_spec = File.read(spec_path)
-        lacking_methods = c.method_list
-          .select { |m| m.visibility == :public }
-          .reject { |m| existing_spec.match(m.name) }
-
-        if lacking_methods.empty? 
-          puts "#{spec_path} skipped."
-        else
-          # Since 'methods_to_generate' is used in ERB template, don't delete.
-          methods_to_generate = lacking_methods
-          additional_spec = create_erb_instance_for_appending(rails_mode, spec_path).result(binding)
-          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
-          else
-            File.open(spec_path, 'w') { |f| f.write(code) }
-          end
-          puts "#{spec_path} modified."
-        end
-
-      else
-        # Create a new spec 
-
-        # Since 'methods_to_generate' is used in ERB template, don't delete.
-        methods_to_generate = c.method_list.select { |m| m.visibility == :public }
-        self_path = to_string_value_to_require(file_path)
-        code = create_erb_instance_for_new_spec(rails_mode, self_path).result(binding)
-
-        if dry_run
-          puts "----- #{spec_path} -----"
-          puts code
-        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
-        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 defined?(RDoc::Store)
-      # RDoc 4.0.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
+        append_to_existing_spec(class_or_module, dry_run, rails_mode, spec_path)
       else
-        extract_target_class_or_module(m)
+        create_new_spec(class_or_module, dry_run, rails_mode, file_path, spec_path)
       end
     else
-      c
+      puts "#{file_path} skipped (Class/Module not found)."
     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}")
+  def get_complete_class_name(class_or_module, name = class_or_module.name)
+    if !class_or_module.parent.name.nil? && class_or_module.parent.is_a?(RDoc::NormalModule)
+      get_complete_class_name(class_or_module.parent, "#{class_or_module.parent.name}::#{name}")
     else
       name
     end
@@ -192,38 +97,72 @@ class RSpecKickstarter::Generator
   end
 
   #
-  # Returns ERB instance for creating new spec
+  # Creates new spec.
   #
-  def create_erb_instance_for_new_spec(rails_mode, target_path)
-    if ! @full_template.nil? 
-      ERB.new(@full_template, nil, '-', '_new_spec_code')
-    elsif rails_mode && target_path.match(/controllers/)
-      ERB.new(RAILS_CONTROLLER_NEW_SPEC_TEMPLATE, nil, '-', '_new_spec_code')
-    elsif rails_mode && target_path.match(/helpers/)
-      ERB.new(RAILS_HELPER_NEW_SPEC_TEMPLATE, nil, '-', '_new_spec_code')
+  def create_new_spec(class_or_module, dry_run, rails_mode, file_path, spec_path)
+
+    # These names are used in ERB template, don't delete.
+    methods_to_generate = class_or_module.method_list.select { |m| m.visibility == :public }
+    c = class_or_module
+    self_path = to_string_value_to_require(file_path)
+
+    erb = RSpecKickstarter::ERBFactory.new(@full_template).get_instance_for_new_spec(rails_mode, file_path)
+    code = erb.result(binding)
+
+    if dry_run
+      puts "----- #{spec_path} -----"
+      puts code
     else
-      ERB.new(BASIC_NEW_SPEC_TEMPLATE, nil, '-', '_new_spec_code')
+      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
     end
   end
 
   #
-  # Returns ERB instance for appeding lacking tests
+  # Appends new tests to the existing spec.
   #
-  def create_erb_instance_for_appending(rails_mode, target_path)
-    if ! @delta_template.nil?
-      ERB.new(@delta_template, nil, '-', '_additional_spec_code')
-    elsif rails_mode && target_path.match(/controllers/)
-      ERB.new(RAILS_CONTROLLER_METHODS_PART_TEMPLATE, nil, '-', '_additional_spec_code')
-    elsif rails_mode && target_path.match(/helpers/)
-      ERB.new(RAILS_HELPER_METHODS_PART_TEMPLATE, nil, '-', '_additional_spec_code')
+  def append_to_existing_spec(class_or_module, dry_run, rails_mode, spec_path)
+    existing_spec = File.read(spec_path)
+    lacking_methods = class_or_module.method_list
+      .select { |m| m.visibility == :public }
+      .reject { |m| existing_spec.match(m.name) }
+
+    if lacking_methods.empty?
+      puts "#{spec_path} skipped."
     else
-      ERB.new(BASIC_METHODS_PART_TEMPLATE, nil, '-', '_additional_spec_code')
+      # These names are used in ERB template, don't delete.
+      methods_to_generate = lacking_methods
+      c = class_or_module
+
+      erb = RSpecKickstarter::ERBFactory.new(@delta_template).get_instance_for_appending(rails_mode, spec_path)
+      additional_spec = erb.result(binding)
+      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
+      else
+        File.open(spec_path, 'w') { |f| f.write(code) }
+      end
+      puts "#{spec_path} modified."
     end
   end
 
-  # 
+  # -----
   # Code generation
-  #
+  # -----
 
   #
   # e.g.
@@ -286,85 +225,15 @@ class RSpecKickstarter::Generator
     http_method.nil? ? 'get' : http_method
   end
 
-  BASIC_METHODS_PART_TEMPLATE = <<SPEC
-<%- methods_to_generate.map { |method| %>
-  # TODO auto-generated
-  describe '#<%= method.name %>' do
-    it 'works' do
-<%- unless get_instantiation_code(c, method).nil?      -%><%= get_instantiation_code(c, method) %><%- end -%>
-<%- unless get_params_initialization_code(method).nil? -%><%= get_params_initialization_code(method) %><%- end -%>
-      result = <%= get_method_invocation_code(c, method) %>
-      expect(result).not_to be_nil
-    end
-  end
-<% } %>
-SPEC
-
-  BASIC_NEW_SPEC_TEMPLATE = <<SPEC
-# -*- encoding: utf-8 -*-
-
-require 'spec_helper'
-<% unless rails_mode then %>require '<%= self_path %>'
-<% end -%>
-
-describe <%= get_complete_class_name(c) %> do
-<%= ERB.new(BASIC_METHODS_PART_TEMPLATE, nil, '-').result(binding) -%>
-end
-SPEC
-
   RAILS_RESOURCE_METHOD_AND_HTTPMETHOD = {
     'index'   => 'get',
     'new'     => 'get',
-    'create'  => 'post', 
+    'create'  => 'post',
     'show'    => 'get',
     'edit'    => 'get',
     'update'  => 'put',
-    'destroy' => 'delete' 
+    'destroy' => 'delete'
   }
 
-  RAILS_CONTROLLER_METHODS_PART_TEMPLATE = <<SPEC
-<%- methods_to_generate.map { |method| %>
-  # TODO auto-generated
-  describe '<%= get_rails_http_method(method.name).upcase %> <%= method.name %>' do
-    it 'works' do
-      <%= get_rails_http_method(method.name) %> :<%= method.name %>, {}, {}
-      expect(response.status).to eq(200)
-    end
-  end
-<% } %>
-SPEC
-
-  RAILS_CONTROLLER_NEW_SPEC_TEMPLATE = <<SPEC
-# -*- encoding: utf-8 -*-
-
-require 'spec_helper'
-
-describe <%= get_complete_class_name(c) %> do
-<%= ERB.new(RAILS_CONTROLLER_METHODS_PART_TEMPLATE, nil, '-').result(binding) -%>
-end
-SPEC
-
-  RAILS_HELPER_METHODS_PART_TEMPLATE = <<SPEC
-<%- methods_to_generate.map { |method| %>
-  # TODO auto-generated
-  describe '#<%= method.name %>' do
-    it 'works' do
-      result = <%= get_rails_helper_method_invocation_code(method) %>
-      expect(result).not_to be_nil
-    end
-  end
-<% } %>
-SPEC
-
-  RAILS_HELPER_NEW_SPEC_TEMPLATE = <<SPEC
-# -*- encoding: utf-8 -*-
-
-require 'spec_helper'
-
-describe <%= get_complete_class_name(c) %> do
-<%= ERB.new(RAILS_HELPER_METHODS_PART_TEMPLATE, nil, '-').result(binding) -%>
-end
-SPEC
-
 end
 

data/lib/rspec_kickstarter/rdoc_factory.rb

@@ -0,0 +1,72 @@
+# -*- encoding: utf-8 -*-
+
+require 'rdoc'
+require 'rdoc/generator'
+require 'rdoc/options'
+require 'rdoc/parser/ruby'
+require 'rdoc/stats'
+
+require 'rspec_kickstarter'
+
+#
+# RDoc instance factory
+#
+class RSpecKickstarter::RDocFactory
+
+  #
+  # Returns RDoc::NormalClass/RDoc::NormalModule instance.
+  #
+  def self.get_rdoc_class_or_module(file_path)
+    top_level = self.get_ruby_parser(file_path).scan
+    self.extract_target_class_or_module(top_level)
+  end
+
+  private
+
+  #
+  # Creates new RDoc::Parser::Ruby instance.
+  #
+  def self.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 defined?(RDoc::Store)
+      # RDoc 4.0.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 self.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
+
+end

data/lib/rspec_kickstarter/version.rb

@@ -1,3 +1,3 @@
 module RSpecKickstarter
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-kickstarter
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-13 00:00:00.000000000 Z
 dependencies: []
 description: rspec-kickstarter supports you writing tests for existing code.
 email:
@@ -20,7 +20,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/rspec-kickstarter
+- lib/rspec_kickstarter/erb_factory.rb
+- lib/rspec_kickstarter/erb_templates.rb
 - lib/rspec_kickstarter/generator.rb
+- lib/rspec_kickstarter/rdoc_factory.rb
 - lib/rspec_kickstarter/version.rb
 - lib/rspec_kickstarter.rb
 homepage: https://github.com/seratch/rspec-kickstarter