gemsmith 2.0.0 → 2.1.0

data/lib/gemsmith/cli_options.rb

@@ -0,0 +1,94 @@
+module Gemsmith
+  module CLIOptions
+    module_function
+
+    # Initializes template options with default and/or command line overrides.
+    # ==== Parameters
+    # * +name+ - Required. The gem name.
+    # * +options+ - Optional. Additional command line options. Default: {}.
+    def initialize_template_options name, options = {}
+      @settings.merge! options
+      @settings = enforce_symbol_keys @settings
+
+      gem_name name
+      gem_class name
+
+      @template_options = {
+        gem_name: gem_name,
+        gem_class: gem_class,
+        gem_platform: gem_platform,
+        gem_url: gem_url,
+        author_name: author_name,
+        author_email: author_email,
+        author_url: author_url,
+        company_name: company_name,
+        company_url: company_url,
+        github_user: github_user,
+        year: year,
+        ruby_version: ruby_version,
+        ruby_patch: ruby_patch,
+        rails_version: rails_version,
+        post_install_message: @settings[:post_install_message],
+        bin: default_boolean(:bin),
+        rails: default_boolean(:rails),
+        pry: default_boolean(:pry, true),
+        guard: default_boolean(:guard, true),
+        rspec: default_boolean(:rspec, true),
+        travis: default_boolean(:travis, true),
+        code_climate: default_boolean(:code_climate, true)
+      }
+    end
+
+    def gem_platform
+      @settings[:gem_platform] || "Gem::Platform::RUBY"
+    end
+
+    def gem_url
+      @settings[:gem_url] || author_url
+    end
+
+    def author_name
+      @settings[:author_name] || Gemsmith::Kit.git_config_value("user.name") || "TODO: Add full name here."
+    end
+
+    def author_email
+      @settings[:author_email] || Gemsmith::Kit.git_config_value("user.email") || "TODO: Add email address here."
+    end
+
+    def author_url
+      @settings[:author_url] || "https://www.unknown.com"
+    end
+
+    def company_name
+      @settings[:company_name] || author_name
+    end
+
+    def company_url
+      @settings[:company_url] || author_url
+    end
+
+    def github_user
+      @settings[:github_user] || Gemsmith::Kit.git_config_value("github.user") || "unknown"
+    end
+
+    def year
+      @settings[:year] || Time.now.year
+    end
+
+    def ruby_version
+      @settings[:ruby_version] || "2.0.0"
+    end
+
+    def ruby_patch
+      @settings[:ruby_patch] || "p0"
+    end
+
+    def rails_version
+      @settings[:rails_version] || "3.0"
+    end
+
+    def default_boolean key, value = false
+      @settings.has_key?(key) ? @settings[key] : value
+    end
+  end
+end

data/lib/gemsmith/skeletons/base_skeleton.rb

@@ -0,0 +1,35 @@
+module Gemsmith
+  module Skeletons
+    class BaseSkeleton
+      def initialize cli
+        @cli = cli
+      end
+
+      def self.run cli
+        self.new(cli).create
+      end
+
+      def create
+        public_methods.each { |method| public_send(method) if method =~ /^create_.+$/ }
+      end
+
+      def respond_to? name, include_private = false
+        @cli.respond_to?(name, include_private) || super(name, include_private)
+      end
+
+      def method_missing name, *args, &block
+        if respond_to?(name)
+          @cli.public_send name, *args, &block
+        else
+          super name, *args, &block
+        end
+      end
+
+      private
+
+      def lib_root
+        "%gem_name%/lib"
+      end
+    end
+  end
+end

data/lib/gemsmith/skeletons/cli_skeleton.rb

@@ -0,0 +1,10 @@
+module Gemsmith
+  module Skeletons
+    class CLISkeleton < BaseSkeleton
+      def create_files
+        template "%gem_name%/bin/%gem_name%.tt", template_options
+        template "%gem_name%/lib/%gem_name%/cli.rb.tt", template_options
+      end
+    end
+  end
+end

data/lib/gemsmith/skeletons/default_skeleton.rb

@@ -0,0 +1,21 @@
+module Gemsmith
+  module Skeletons
+    class DefaultSkeleton < BaseSkeleton
+      def create_default_files
+        template "%gem_name%/Gemfile.tt", template_options
+        template "%gem_name%/Rakefile.tt", template_options
+        template "%gem_name%/%gem_name%.gemspec.tt", template_options
+        template "#{lib_root}/%gem_name%.rb.tt", template_options
+        template "#{lib_root}/%gem_name%/version.rb.tt", template_options
+      end
+
+      def create_ruby_files
+        template "%gem_name%/.ruby-version.tt", template_options
+      end
+
+      def create_git_files
+        template "%gem_name%/.gitignore.tt", template_options
+      end
+    end
+  end
+end

data/lib/gemsmith/skeletons/documentation_skeleton.rb

@@ -0,0 +1,12 @@
+module Gemsmith
+  module Skeletons
+    class DocumentationSkeleton < BaseSkeleton
+      def create_files
+        template "%gem_name%/README.md.tt", template_options
+        template "%gem_name%/CONTRIBUTING.md.tt", template_options
+        template "%gem_name%/LICENSE.md.tt", template_options
+        template "%gem_name%/CHANGELOG.md.tt", template_options
+      end
+    end
+  end
+end

data/lib/gemsmith/skeletons/git_skeleton.rb

@@ -0,0 +1,13 @@
+module Gemsmith
+  module Skeletons
+    class GitSkeleton < BaseSkeleton
+      def create_files
+        Dir.chdir(File.join(destination_root, gem_name)) do
+          `git init`
+          `git add .`
+          `git commit -a -n -m "Gemsmith skeleton created."`
+        end
+      end
+    end
+  end
+end

data/lib/gemsmith/skeletons/rails_skeleton.rb

@@ -0,0 +1,51 @@
+module Gemsmith
+  module Skeletons
+    class RailsSkeleton < BaseSkeleton
+      def create_model_files
+        template "#{model_root}/class_methods.rb.tt", template_options
+        template "#{model_root}/instance_methods.rb.tt", template_options
+      end
+
+      def create_view_files
+        template "#{lib_gem_root}/action_view/instance_methods.rb.tt", template_options
+      end
+
+      def create_controller_files
+        template "#{controller_root}/class_methods.rb.tt", template_options
+        template "#{controller_root}/instance_methods.rb.tt", template_options
+      end
+
+      def create_generator_files
+        empty_directory "#{generator_root}/templates"
+        template "#{generator_root}/install/install_generator.rb.tt", template_options
+        template "#{generator_root}/install/USAGE.tt", template_options
+        template "#{generator_root}/upgrade/upgrade_generator.rb.tt", template_options
+        template "#{generator_root}/upgrade/USAGE.tt", template_options
+      end
+
+      def create_travis_gemfiles
+        if template_options[:travis]
+          template "%gem_name%/gemfiles/rails-3.2.x.gemfile.tt", template_options
+        end
+      end
+
+      private
+
+      def lib_gem_root
+        "#{lib_root}/%gem_name%"
+      end
+
+      def model_root
+        "#{lib_gem_root}/active_record"
+      end
+
+      def controller_root
+        "#{lib_gem_root}/action_controller"
+      end
+
+      def generator_root
+        "#{lib_root}/generators/%gem_name%"
+      end
+    end
+  end
+end

data/lib/gemsmith/skeletons/rspec_skeleton.rb

@@ -0,0 +1,17 @@
+module Gemsmith
+  module Skeletons
+    class RspecSkeleton < BaseSkeleton
+      def create_files
+        template "%gem_name%/.rspec.tt", template_options
+        template "#{rspec_root}/spec_helper.rb.tt", template_options
+        template "#{rspec_root}/%gem_name%_spec.rb.tt", template_options
+      end
+
+      private
+
+      def rspec_root
+        "%gem_name%/spec"
+      end
+    end
+  end
+end

data/lib/gemsmith/skeletons/travis_skeleton.rb

@@ -0,0 +1,9 @@
+module Gemsmith
+  module Skeletons
+    class TravisSkeleton < BaseSkeleton
+      def create_files
+        template "%gem_name%/.travis.yml.tt", template_options
+      end
+    end
+  end
+end

data/lib/gemsmith/templates/{gem.gemspec.tmp → %gem_name%/%gem_name%.gemspec.tt}

@@ -29,7 +29,8 @@ Gem::Specification.new do |s|
 	<%- end -%>
   <%- if config[:pry] -%>
   s.add_development_dependency "pry"
-  s.add_development_dependency "pry-nav"
+  s.add_development_dependency "pry-debugger"
+  s.add_development_dependency "pry-rescue"
   s.add_development_dependency "pry-stack_explorer"
   s.add_development_dependency "pry-vterm_aliases"
   <%- end -%>
@@ -45,9 +46,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rb-inotify" # Guard file events for Linux.
   s.add_development_dependency "guard-rspec"
 	<%- end -%>
-	
+
   s.files            = Dir["lib/**/*", "vendor/**/*"]
-  s.extra_rdoc_files = Dir["README*", "CHANGELOG*", "LICENSE*"]
+  s.extra_rdoc_files = Dir["README*", "LICENSE*"]
   <%- if config[:bin] -%>
 	s.executables      << "<%= config[:gem_name] %>"
 	<%- end -%>

data/lib/gemsmith/templates/{gitignore.tmp → %gem_name%/.gitignore.tt}

@@ -1,5 +1,6 @@
 *.gem
 .bundle
+.ruby-version
 Gemfile.lock
 pkg/*
-spec/tmp
+spec/tmp

data/lib/gemsmith/templates/%gem_name%/.ruby-version.tt

@@ -0,0 +1 @@
+<%= [config[:ruby_version], config[:ruby_patch]] * '-' %>

data/lib/gemsmith/templates/{travis.yml.tmp → %gem_name%/.travis.yml.tt}

@@ -3,8 +3,6 @@ rvm:
   - 2.0.0
 <%- if config[:rails] -%>
 gemfile:
-  - gemfiles/rails-3.0.x.gemfile
-  - gemfiles/rails-3.1.x.gemfile
   - gemfiles/rails-3.2.x.gemfile
 <%- end -%>
 script: bundle exec rspec spec

data/lib/gemsmith/templates/{CHANGELOG.rdoc.tmp → %gem_name%/CHANGELOG.md.tt}

@@ -1,3 +1,3 @@
-= v0.1.0
+# v0.1.0
 
 * Initial version.

data/lib/gemsmith/templates/{LICENSE.rdoc.tmp → %gem_name%/LICENSE.md.tt}

@@ -1,4 +1,4 @@
-Copyright (c) <%= config[:year] %> {<%= config[:company_name] %>}[<%= config[:company_url] %>].
+Copyright (c) <%= config[:year] %> [<%= config[:company_name] %>](<%= config[:company_url] %>).
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/gemsmith/templates/%gem_name%/README.md.tt

@@ -0,0 +1,59 @@
+# Overview
+
+[![Gem Version](https://badge.fury.io/rb/<%= config[:gem_name] %>.png)](http://badge.fury.io/rb/<%= config[:gem_name] %>)
+<%- if config[:code_climate] -%>
+[![Code Climate GPA](https://codeclimate.com/github/<%= config[:github_user] %>/<%= config[:gem_name] %>.png)](https://codeclimate.com/github/<%= config[:github_user] %>/<%= config[:gem_name] %>)
+<%- end -%>
+<%- if config[:travis] -%>
+[![Travis CI Status](https://secure.travis-ci.org/<%= config[:github_user] %>/<%= config[:gem_name] %>.png)](http://travis-ci.org/<%= config[:github_user] %>/<%= config[:gem_name] %>)
+<%- end -%>
+
+# Features
+
+# Requirements
+
+<%- if config[:rails] -%>
+0. [Ruby on Rails](http://rubyonrails.org).
+<%- end -%>
+
+# Setup
+
+Type the following from the command line to install:
+
+    gem install <%= config[:gem_name] %>
+
+<%- if config[:rails] -%>
+Add the following to your Gemfile:
+
+    gem "<%= config[:gem_name] %>"
+<%- end -%>
+
+# Usage
+
+<%- if config[:rspec] -%>
+# Tests
+
+To test, do the following:
+
+0. cd to the gem root.
+0. bundle install
+0. bundle exec rspec spec
+<%- end -%>
+
+# Contributions
+
+Read CONTRIBUTING for details.
+
+# Credits
+
+Developed by [<%= config[:author_name] %>](<%= config[:author_url] %>) at [<%= config[:company_name] %>](<%= config[:company_url] %>).
+
+# License
+
+Copyright (c) <%= config[:year] %> [<%= config[:company_name] %>](<%= config[:company_url] %>).
+Read the LICENSE for details.
+
+# History
+
+Read the CHANGELOG for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).

data/lib/gemsmith/templates/{gemfiles/rails-3.2.x.gemfile.tmp → %gem_name%/gemfiles/rails-3.2.x.gemfile.tt}

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 
 gem "rails", "~> 3.2.0"
 

data/lib/gemsmith/templates/%gem_name%/lib/%gem_name%.rb.tt

@@ -0,0 +1,33 @@
+require "<%= config[:gem_name] %>/version"
+
+<%- if config[:rails] -%>
+# Rails Enhancements
+if defined? Rails
+  # Dependencies
+  require "<%= config[:gem_name] %>/active_record/class_methods"
+  require "<%= config[:gem_name] %>/active_record/instance_methods"
+  require "<%= config[:gem_name] %>/action_view/instance_methods"
+  require "<%= config[:gem_name] %>/action_controller/class_methods"
+  require "<%= config[:gem_name] %>/action_controller/instance_methods"
+
+  # Model
+  if defined? ActiveRecord
+    ActiveRecord::Base.send :include, <%= config[:gem_class] %>::ActiveRecord
+  end
+
+  # View
+  if defined? ActionView
+    ActionView::Base.send :include, <%= config[:gem_class] %>::ActionView
+  end
+
+  # Controller
+  if defined? ActionController
+    ActionController::Base.send :include, <%= config[:gem_class] %>::ActionController
+  end
+end
+<%- else -%>
+# Namespace
+module <%= config[:gem_class] %>
+  # TODO - Add code here.
+end
+<%- end -%>