gem_bootstrap 0.2.7 → 0.2.8

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+#### 0.2.8
+
+- Add some tests (better late than never)
+- Add Guardfile for TDD/BDD
+
 #### 0.2.7
 
 - Use require instead require_relative

data/lib/gem_bootstrap.rb

@@ -1,3 +1,4 @@
+# external libraries
 require 'grit'
 require 'open3'
 require 'thor'
@@ -5,7 +6,9 @@ require 'active_support'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/hash/indifferent_access'
+# internal files
 require 'gem_bootstrap/version'
+require 'gem_bootstrap/errors'
 require 'gem_bootstrap/cli'
 require 'gem_bootstrap/git_utils'
 require 'gem_bootstrap/misc_utils'

data/lib/gem_bootstrap/errors.rb

@@ -0,0 +1,5 @@
+module GemBootstrap
+  class Errors
+    CustomError = Class.new(StandardError)
+  end
+end

data/lib/gem_bootstrap/git_utils.rb

@@ -21,6 +21,8 @@ module GemBootstrap
         git_add(base_dir, files)
       end
 
+      private
+
       # Run the `git init` on a given directory
       #
       # @param [String] base_dir the starting directory
@@ -46,8 +48,6 @@ module GemBootstrap
         end
       end
 
-      private
-
       def expand_path(base_dir)
         raise "Invalid directory name `{base_dir}`" if base_dir.nil? || !File.directory?(File.new(base_dir))
         File.expand_path(base_dir)

data/lib/gem_bootstrap/misc_utils.rb

@@ -1,13 +1,12 @@
 module GemBootstrap
   class MiscUtils
-    CustomError = Class.new(StandardError)
-
     class << self
       # Receives a string and convert it to snake case.
       # SnakeCase returns snake_case.
       #
       # @param [String] str the input string
       def snake_case(str)
+        # for testing only
         return str.downcase if str =~ /^[A-Z_]+$/
         str.gsub(/\B[A-Z]/, '_\&').squeeze('_') =~ /_*(.*)/
         $+.downcase
@@ -27,14 +26,14 @@ module GemBootstrap
       # @param [Hash<Symbol, Object>] args keys and values of argument
       def files(args = {})
         opts = {
-          base_dir: Dir.pwd,
+          base_dir:  Dir.pwd,
           recursive: false,
-          exts: [],
-          non_exts: []
+          exts:      [],
+          non_exts:  []
         }.merge(args)
 
         base_dir = opts[:base_dir]
-        fail CustomError, "The directory #{base_dir} is not valid or or not readable!" unless File.exist?(base_dir)
+        fail Errors::CustomError, "The directory #{base_dir} is not valid or or not readable!" unless File.exist?(base_dir)
 
         wildcard = opts[:recursive] ? '**' : ''
         exts     = opts[:exts]

data/lib/gem_bootstrap/version.rb

@@ -1,3 +1,3 @@
 module GemBootstrap
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 end

data/templates/Guardfile-minitest

@@ -1,4 +1,3 @@
-# A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 guard 'minitest' do
   watch(%r|^test/(.*)\/?test_(.*)\.rb|)

data/templates/Guardfile-rspec

@@ -1,4 +1,3 @@
-# A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 guard :rspec, cmd: 'rspec', all_on_start: true, all_after_pass: true do
   watch(%r{^spec/.+_spec\.rb$})

data/templates/Rakefile-minitest

@@ -6,7 +6,6 @@ Rake::TestTask.new do |t|
   t.test_files = FileList["test/lib/#{project_name}/test_*.rb"]
   t.verbose = true
 end
-
 task default: [:test, :rubocop]
 task :pry do
   require 'pry'
@@ -16,7 +15,6 @@ task :pry do
   ARGV.clear
   Pry.start
 end
-
 require 'rubocop/rake_task'
 desc 'Run RuboCop on the lib directory'
 RuboCop::RakeTask.new(:rubocop) do |task|

data/templates/Rakefile-rspec

@@ -2,7 +2,6 @@ require "bundler/gem_tasks"
 Bundler::GemHelper.install_tasks
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
-
 task :pry do
   require "pry"
   require "awesome_print"
@@ -11,7 +10,6 @@ task :pry do
   ARGV.clear
   Pry.start
 end
-
 require "rubocop/rake_task"
 desc "Run RuboCop on the lib directory"
 RuboCop::RakeTask.new(:rubocop) do |task|
@@ -19,5 +17,4 @@ RuboCop::RakeTask.new(:rubocop) do |task|
   task.formatters    = ["files"]
   task.fail_on_error = false
 end
-
 task default: [:spec, :rubocop]

data/templates/bin/newgem

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 require_relative '../lib/<%= name %>'
-include <%= MiscUtils.camel_case(name) %>
 if ARGV.empty?
   <%= MiscUtils.camel_case(name) %>::CLI.start(%w[usage])
 else

data/templates/lib/newgem.rb

@@ -4,7 +4,7 @@ require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/kernel/reporting'
 require 'thor'
-require_relative '<%= name %>/version'
-require_relative '<%= name %>/<%= name %>'
-require_relative '<%= name %>/cli'
+require '<%= name %>/version'
+require '<%= name %>/<%= name %>'
+require '<%= name %>/cli'
 include <%= MiscUtils.camel_case(name) %>

data/templates/lib/newgem/newgem.rb

@@ -1,7 +1,6 @@
 module <%= MiscUtils.camel_case(name) %>
   CustomError = Class.new(StandardError)
   class << self
-    # main helper method
     def helper
       puts 'FYI: <%= MiscUtils.camel_case(name) %>::helper()'
     end

data/templates/newgem-minitest.gemspec.tt

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-minitest', '~> 2.3.2'
   spec.add_development_dependency 'minitest', '~> 5.4.2'
   spec.add_development_dependency 'minitest-spec-context', '~> 0.0.3'
-  spec.add_development_dependency 'pry', '~> 0.10.0'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
   spec.add_development_dependency 'pry-byebug', '~> 2.0.0' if RUBY_VERSION >= '2.0.0'
   spec.add_development_dependency 'rake', '~> 10.3.2'
   spec.add_development_dependency 'rubocop', '~> 0.26.1'

data/test/lib/gem_bootstrap/test_misc_utils.rb

@@ -0,0 +1,62 @@
+require_relative '../../test_helper'
+describe GemBootstrap do
+  describe '#snake_case' do
+    it 'handles camel case text properly' do
+      MiscUtils.snake_case("someText").must_equal("some_text")
+      MiscUtils.snake_case("SomeText").must_equal("some_text")
+    end
+    it 'handles string that does not start with lowercase' do
+      MiscUtils.snake_case("Sometext").must_equal("sometext")
+    end
+  end
+  describe '#camel_case' do
+    it 'handles string with underscore' do
+      MiscUtils.camel_case("some_text").must_equal("SomeText")
+      MiscUtils.camel_case("_some_text").must_equal("SomeText")
+    end
+    it 'handles string without underscore' do
+      MiscUtils.camel_case("html2pdf").must_equal("Html2pdf")
+    end
+  end
+  describe '#files' do
+    let :fixtures_dir do
+      File.expand_path("../../../fixtures", __FILE__)
+    end
+    context 'non matching file' do
+      it 'returns empty list by default' do
+        MiscUtils.files.must_equal []
+      end
+      it 'returns empty list for non-matching files' do
+        result = MiscUtils.files(base_dir: fixtures_dir,
+                                exts: %w(invalid_extension),
+                                recursive: true)
+        result.must_be_empty
+      end
+    end
+    context 'recursive' do
+      it 'returns proper list of files' do
+        result = MiscUtils.files(base_dir: fixtures_dir,
+                                 exts: %w(txt),
+                                 recursive: true)
+        result.map! { |file| file.gsub(fixtures_dir, '') }
+        result.must_equal ['/file1.txt', '/file2.txt', '/sub_dir/file3.txt', '/sub_dir/file4.txt']
+      end
+      it 'returns all files including one with no extension' do
+        result = MiscUtils.files(base_dir: fixtures_dir,
+                                 exts: %w(txt),
+                                 non_exts: %w(file0),
+                                 recursive: true)
+        result.map! { |file| file.gsub(fixtures_dir, '') }
+        result.must_equal ['/file0', '/file1.txt', '/file2.txt', '/sub_dir/file3.txt', '/sub_dir/file4.txt']
+      end
+    end
+    context 'non-recursive' do
+      it 'returns proper list of files' do
+        result = MiscUtils.files(base_dir: fixtures_dir,
+                                exts: %w(txt))
+        result.map! { |file| file.gsub(fixtures_dir, '') }
+        result.must_equal ['/file1.txt', '/file2.txt' ]
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2014-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport-core-ext
@@ -248,6 +248,7 @@ extra_rdoc_files: []
 files:
 - bin/gem_bootstrap
 - lib/gem_bootstrap/cli.rb
+- lib/gem_bootstrap/errors.rb
 - lib/gem_bootstrap/gem_bootstrap.rb
 - lib/gem_bootstrap/git_utils.rb
 - lib/gem_bootstrap/misc_utils.rb
@@ -284,7 +285,13 @@ files:
 - LICENSE
 - .rubocop.yml
 - .gitignore
+- test/fixtures/file0
+- test/fixtures/file1.txt
+- test/fixtures/file2.txt
+- test/fixtures/sub_dir/file3.txt
+- test/fixtures/sub_dir/file4.txt
 - test/lib/gem_bootstrap/test_gem_bootstrap.rb
+- test/lib/gem_bootstrap/test_misc_utils.rb
 - test/test_helper.rb
 homepage: https://github.com/agilecreativity/gem_bootstrap
 licenses:
@@ -312,6 +319,12 @@ signing_key:
 specification_version: 3
 summary: Bootstrap the creation of ruby gem so that you don't have to start from scratch
 test_files:
+- test/fixtures/file0
+- test/fixtures/file1.txt
+- test/fixtures/file2.txt
+- test/fixtures/sub_dir/file3.txt
+- test/fixtures/sub_dir/file4.txt
 - test/lib/gem_bootstrap/test_gem_bootstrap.rb
+- test/lib/gem_bootstrap/test_misc_utils.rb
 - test/test_helper.rb
 has_rdoc: