gemsmith 5.6.0 → 6.0.0

data/lib/gemsmith/skeletons/rails_skeleton.rb

@@ -2,42 +2,44 @@ module Gemsmith
   module Skeletons
     # Configures Ruby on Rails support.
     class RailsSkeleton < BaseSkeleton
-      def enabled?
-        cli.template_options.key?(:rails) && cli.template_options[:rails]
+      def rails?
+        cli.run "command -v rails > /dev/null"
       end
 
-      def rails?
-        system "command -v rails"
+      def install_rails
+        return if rails?
+        return unless cli.yes?("Ruby on Rails is not installed. Would you like to install it (y/n)?")
+        cli.run "gem install rails"
       end
 
       def create_engine
-        cli.template "#{lib_root}/%gem_name%/engine.rb.tt", cli.template_options
-
-        gem_name = cli.template_options.fetch :gem_name
-        system "rails plugin new --skip #{gem_name} #{engine_options}"
+        gem_name = configuration.gem_name
 
-        cli.remove_file "#{gem_name}/app/helpers/#{gem_name}/application_helper.rb", cli.template_options
-        cli.remove_file "#{gem_name}/lib/#{gem_name}/version.rb", cli.template_options
-        cli.remove_file "#{gem_name}/MIT-LICENSE", cli.template_options
-        cli.remove_file "#{gem_name}/README.rdoc", cli.template_options
+        cli.template "#{lib_root}/%gem_name%/engine.rb.tt", configuration.to_h
+        cli.run "rails plugin new --skip #{gem_name} #{engine_options}"
+        cli.remove_file "#{gem_name}/app/helpers/#{gem_name}/application_helper.rb", configuration.to_h
+        cli.remove_file "#{gem_name}/lib/#{gem_name}/version.rb", configuration.to_h
+        cli.remove_file "#{gem_name}/MIT-LICENSE", configuration.to_h
+        cli.remove_file "#{gem_name}/README.rdoc", configuration.to_h
       end
 
       def create_generator_files
         cli.empty_directory "#{generator_root}/templates"
-        cli.template "#{generator_root}/install/install_generator.rb.tt", cli.template_options
-        cli.template "#{generator_root}/install/USAGE.tt", cli.template_options
-        cli.template "#{generator_root}/upgrade/upgrade_generator.rb.tt", cli.template_options
-        cli.template "#{generator_root}/upgrade/USAGE.tt", cli.template_options
+        cli.template "#{generator_root}/install/install_generator.rb.tt", configuration.to_h
+        cli.template "#{generator_root}/install/USAGE.tt", configuration.to_h
+        cli.template "#{generator_root}/upgrade/upgrade_generator.rb.tt", configuration.to_h
+        cli.template "#{generator_root}/upgrade/USAGE.tt", configuration.to_h
       end
 
       def create_travis_gemfiles
-        return unless cli.template_options[:travis]
-        cli.template "%gem_name%/gemfiles/rails-4.1.x.gemfile.tt", cli.template_options
+        return unless configuration.create_travis?
+        cli.template "%gem_name%/gemfiles/rails-%rails_version%.x.gemfile.tt", configuration.to_h
       end
 
       def create
-        return unless enabled? && rails?
+        return unless configuration.create_rails?
 
+        install_rails
         create_engine
         create_generator_files
         create_travis_gemfiles

data/lib/gemsmith/skeletons/rake_skeleton.rb

@@ -2,33 +2,28 @@ module Gemsmith
   module Skeletons
     # Configures Rake support.
     class RakeSkeleton < BaseSkeleton
-      def self.allowed_options
-        {
-          rspec: "spec",
-          rubocop: "rubocop"
-        }
-      end
-
       def create
-        cli.template "%gem_name%/Rakefile.tt", cli.template_options
+        cli.template "%gem_name%/Rakefile.tt", configuration.to_h
         configure_rakefile
       end
 
       private
 
-      def allowed_options?
-        cli.template_options.keys.any? { |key| self.class.allowed_options.keys.include? key }
+      def rspec_task
+        "spec" if configuration.create_rspec?
+      end
+
+      def rubocop_task
+        "rubocop" if configuration.create_rubocop?
       end
 
       def default_tasks
-        cli.template_options.each.with_object([]) do |(key, _), tasks|
-          tasks.push self.class.allowed_options[key]
-        end
+        [rspec_task, rubocop_task].compact
       end
 
       def configure_rakefile
-        return unless allowed_options?
-        cli.append_to_file "%gem_name%/Rakefile", "\ntask default: %w(#{default_tasks.compact.join(' ')})\n"
+        return if default_tasks.empty?
+        cli.append_to_file "%gem_name%/Rakefile", %(\ntask default: %w(#{default_tasks.join(" ")})\n)
       end
     end
   end

data/lib/gemsmith/skeletons/rspec_skeleton.rb

@@ -2,20 +2,16 @@ module Gemsmith
   module Skeletons
     # Configures RSpec support.
     class RspecSkeleton < BaseSkeleton
-      def enabled?
-        cli.template_options.key?(:rspec) && cli.template_options[:rspec]
-      end
-
       def create
-        return unless enabled?
+        return unless configuration.create_rspec?
 
-        cli.template "%gem_name%/lib/%gem_name%/tasks/rspec.rake.tt", cli.template_options
-        cli.template "#{rspec_root}/spec_helper.rb.tt", cli.template_options
-        cli.template "#{rspec_root}/lib/%gem_name%/%gem_name%_spec.rb.tt", cli.template_options
-        cli.template "#{rspec_root}/support/kit/default_config.rb.tt", cli.template_options
-        cli.template "#{rspec_root}/support/kit/stderr.rb.tt", cli.template_options
-        cli.template "#{rspec_root}/support/kit/stdout.rb.tt", cli.template_options
-        cli.template "#{rspec_root}/support/kit/temp_dir.rb.tt", cli.template_options
+        cli.template "%gem_name%/lib/tasks/rspec.rake.tt", configuration.to_h
+        cli.template "#{rspec_root}/spec_helper.rb.tt", configuration.to_h
+        cli.template "#{rspec_root}/lib/%gem_name%/%gem_name%_spec.rb.tt", configuration.to_h
+        cli.template "#{rspec_root}/support/kit/default_config.rb.tt", configuration.to_h
+        cli.template "#{rspec_root}/support/kit/stderr.rb.tt", configuration.to_h
+        cli.template "#{rspec_root}/support/kit/stdout.rb.tt", configuration.to_h
+        cli.template "#{rspec_root}/support/kit/temp_dir.rb.tt", configuration.to_h
       end
 
       private

data/lib/gemsmith/skeletons/rubocop_skeleton.rb

@@ -2,15 +2,11 @@ module Gemsmith
   module Skeletons
     # Configures Rubocop support.
     class RubocopSkeleton < BaseSkeleton
-      def enabled?
-        cli.template_options.key?(:rubocop) && cli.template_options[:rubocop]
-      end
-
       def create
-        return unless enabled?
+        return unless configuration.create_rubocop?
 
-        cli.template "%gem_name%/.rubocop.yml.tt", cli.template_options
-        cli.template "%gem_name%/lib/%gem_name%/tasks/rubocop.rake.tt", cli.template_options
+        cli.template "%gem_name%/.rubocop.yml.tt", configuration.to_h
+        cli.template "%gem_name%/lib/tasks/rubocop.rake.tt", configuration.to_h
       end
     end
   end

data/lib/gemsmith/skeletons/ruby_skeleton.rb

@@ -3,7 +3,7 @@ module Gemsmith
     # Configures Ruby support.
     class RubySkeleton < BaseSkeleton
       def create
-        cli.template "%gem_name%/.ruby-version.tt", cli.template_options
+        cli.template "%gem_name%/.ruby-version.tt", configuration.to_h
       end
     end
   end

data/lib/gemsmith/skeletons/travis_skeleton.rb

@@ -2,13 +2,9 @@ module Gemsmith
   module Skeletons
     # Configures Travis CI support.
     class TravisSkeleton < BaseSkeleton
-      def enabled?
-        cli.template_options.key?(:travis) && cli.template_options[:travis]
-      end
-
       def create
-        return unless enabled?
-        cli.template "%gem_name%/.travis.yml.tt", cli.template_options
+        return unless configuration.create_travis?
+        cli.template "%gem_name%/.travis.yml.tt", configuration.to_h
       end
     end
   end

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

@@ -1,67 +1,61 @@
 $LOAD_PATH.push File.expand_path("../lib", __FILE__)
-require "<%=config[:gem_name]%>/identity"
+require "<%= config.fetch(:gem).fetch(:name) %>/identity"
 
 Gem::Specification.new do |spec|
-  spec.name = <%= config[:gem_class] %>::Identity.name
-  spec.version = <%= config[:gem_class] %>::Identity.version
-  spec.platform = <%= config[:gem_platform] %>
-  spec.authors = ["<%= config[:author_name] %>"]
-  spec.email = ["<%= config[:author_email] %>"]
-  spec.homepage = "<%= config[:gem_url] %>"
+  spec.name = <%= config.fetch(:gem).fetch(:class) %>::Identity.name
+  spec.version = <%= config.fetch(:gem).fetch(:class) %>::Identity.version
+  spec.platform = <%= config.fetch(:gem).fetch(:platform) %>
+  spec.authors = ["<%= config.fetch(:author).fetch(:name) %>"]
+  spec.email = ["<%= config.fetch(:author).fetch(:email) %>"]
+  spec.homepage = "<%= config.fetch(:gem).fetch(:home_url) %>"
   spec.summary = "TODO: Add gem summary here."
   spec.description = "TODO: Add gem description here."
   spec.license = "MIT"
-  <%- if config[:post_install_message] -%>
-  spec.post_install_message	= "<%= config[:post_install_message] %>"
-  <%- end -%>
 
-  <%- if config[:security] -%>
+  <%- if config.fetch(:create).fetch(:security) -%>
   if ENV["RUBY_GEM_SECURITY"] == "enabled"
-    spec.signing_key = File.expand_path("<%= config[:gem_private_key] %>")
-    spec.cert_chain = [File.expand_path("<%= config[:gem_public_key] %>")]
+    spec.signing_key = File.expand_path("<%= config.fetch(:gem).fetch(:private_key) %>")
+    spec.cert_chain = [File.expand_path("<%= config.fetch(:gem).fetch(:public_key) %>")]
   end
   <%- end -%>
 
-  <%- if config[:bin] -%>
+  <%- if config.fetch(:create).fetch(:cli) -%>
   spec.add_dependency "thor"
   spec.add_dependency "thor_plus"
   <%- end -%>
-  <%- if config[:rails] -%>
-  spec.add_dependency "rails", "~> <%= config[:rails_version] %>"
+  <%- if config.fetch(:create).fetch(:rails) -%>
+  spec.add_dependency "rails", "~> <%= config.fetch(:versions).fetch(:rails) %>"
   <%- end -%>
-  <%- if config[:travis] -%>
   spec.add_development_dependency "rake"
-  <%- end -%>
   spec.add_development_dependency "gemsmith"
-  <%- if config[:pry] -%>
+  <%- if config.fetch(:create).fetch(:pry) -%>
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "pry-state"
-  spec.add_development_dependency "pry-stack_explorer"
   spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-state"
   spec.add_development_dependency "pry-rescue"
+  spec.add_development_dependency "pry-stack_explorer"
   <%- end -%>
-  <%- if config[:rspec] -%>
-  <%- rspec_gem = config[:rails] ? "rspec-rails" : "rspec" -%>
-  spec.add_development_dependency "<%= rspec_gem %>"
+  <%- if config.fetch(:create).fetch(:rspec) -%>
+  spec.add_development_dependency "<%= config.fetch(:create).fetch(:rails) ? "rspec-rails" : "rspec" %>"
   <%- end -%>
-  <%- if config[:guard] -%>
+  <%- if config.fetch(:create).fetch(:guard) -%>
   spec.add_development_dependency "rb-fsevent" # Guard file events for OSX.
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "terminal-notifier"
   spec.add_development_dependency "terminal-notifier-guard"
   <%- end -%>
-  <%- if config[:rubocop] -%>
+  <%- if config.fetch(:create).fetch(:rubocop) -%>
   spec.add_development_dependency "rubocop"
   <%- end -%>
-  <%- if config[:code_climate] -%>
+  <%- if config.fetch(:create).fetch(:code_climate) -%>
   spec.add_development_dependency "codeclimate-test-reporter"
   <%- end -%>
 
   spec.files = Dir["lib/**/*", "vendor/**/*"]
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
-  <%- if config[:bin] -%>
-  spec.executables << "<%= config[:gem_name] %>"
+  <%- if config.fetch(:create).fetch(:cli) -%>
+  spec.executables << "<%= config.fetch(:gem).fetch(:name) %>"
   <%- end -%>
   spec.require_paths = ["lib"]
 end

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

@@ -1,4 +1,3 @@
 *.gem
 .bundle
 pkg/*
-spec/tmp

data/lib/gemsmith/templates/%gem_name%/.rubocop.yml.tt

@@ -1,4 +1,4 @@
-<%- if config[:rails] -%>
+<%- if config.fetch(:create).fetch(:rails) -%>
 AllCops:
   RunRailsCops: true
   Exclude:
@@ -21,5 +21,7 @@ Style/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
 Metrics/LineLength:
   Max: 120

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

@@ -1 +1 @@
-<%= config[:ruby_version] %>
+<%= config.fetch(:versions).fetch(:ruby) %>

data/lib/gemsmith/templates/%gem_name%/.travis.yml.tt

@@ -1,10 +1,9 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.0
-<%- if config[:rails] -%>
+  - <%= config.fetch(:versions).fetch(:ruby) %>
+<%- if config.fetch(:create).fetch(:rails) -%>
 gemfile:
-  - gemfiles/rails-4.1.x.gemfile
+  - gemfiles/rails-<%= config.fetch(:versions).fetch(:rails) %>.x.gemfile
 <%- end -%>
 script: bundle exec rake
 notifications:

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

@@ -15,19 +15,28 @@ Examples of unacceptable behavior by participants include:
 * Trolling or insulting/derogatory comments
 * Public or private harassment
 * Publishing other's private information, such as physical or electronic addresses, without explicit permission
-* Other unethical or unprofessional conduct.
+* Other unethical or unprofessional conduct
 
 Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
-issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project
-maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this
-project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the
-project team.
+issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
 
 This code of conduct applies both within project spaces and in public spaces when an individual is representing the
 project or its community.
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting
-one or more of the project maintainers.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer
+at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed
+necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the
+reporter of an incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
 
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0,
-available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

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

@@ -2,7 +2,7 @@ guard :rspec, cmd: "bundle exec rspec" do
   watch(%r(^spec/.+_spec\.rb$))
   watch(%r(^lib/(.+)\.rb$)) { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch("spec/spec_helper.rb") { "spec" }
-  <%- if config[:rails] -%>
+  <%- if config.fetch(:create).fetch(:rails) -%>
 
   # Rails
   watch(%r(^app/(.+)\.rb$)) { |m| "spec/#{m[1]}_spec.rb" }

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

@@ -1,4 +1,4 @@
-Copyright (c) <%= config[:year] %> [<%= config[:company_name] %>](<%= config[:company_url] %>).
+Copyright (c) <%= config.fetch(:year) %> [<%= config.fetch(:organization).fetch(:name) %>](<%= config.fetch(:organization).fetch(: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

@@ -1,62 +1,65 @@
-# <%= config[:gem_class] %>
+# <%= config.fetch(:gem).fetch(:class) %>
 
-[![Gem Version](https://badge.fury.io/rb/<%= config[:gem_name] %>.svg)](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] %>.svg)](https://codeclimate.com/github/<%= config[:github_user] %>/<%= config[:gem_name] %>)
-[![Code Climate Coverage](https://codeclimate.com/github/<%= config[:github_user] %>/<%= config[:gem_name] %>/coverage.svg)](https://codeclimate.com/github/<%= config[:github_user] %>/<%= config[:gem_name] %>)
+[![Gem Version](https://badge.fury.io/rb/<%= config.fetch(:gem).fetch(:name) %>.svg)](http://badge.fury.io/rb/<%= config.fetch(:gem).fetch(:name) %>)
+<%- if config.fetch(:create).fetch(:code_climate) -%>
+[![Code Climate GPA](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>.svg)](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>)
+[![Code Climate Coverage](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>/coverage.svg)](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>)
 <%- end -%>
-<%- if config[:gemnasium] -%>
-[![Gemnasium Status](https://gemnasium.com/<%= config[:github_user] %>/<%= config[:gem_name] %>.svg)](https://gemnasium.com/<%= config[:github_user] %>/<%= config[:gem_name] %>)
+<%- if config.fetch(:create).fetch(:gemnasium) -%>
+[![Gemnasium Status](https://gemnasium.com/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>.svg)](https://gemnasium.com/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>)
 <%- end -%>
-<%- if config[:travis] -%>
-[![Travis CI Status](https://secure.travis-ci.org/<%= config[:github_user] %>/<%= config[:gem_name] %>.svg)](http://travis-ci.org/<%= config[:github_user] %>/<%= config[:gem_name] %>)
+<%- if config.fetch(:create).fetch(:travis) -%>
+[![Travis CI Status](https://secure.travis-ci.org/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>.svg)](http://travis-ci.org/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>)
+<%- end -%>
+<%- if config.fetch(:create).fetch(:patreon) -%>
+[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/<%= config.fetch :github_user %>)
 <%- end -%>
 
-<!-- START doctoc - For use by DocToc (https://github.com/thlorenz/doctoc), autogenerates the table of contents -->
-<!-- END doctoc -->
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
 
 # Features
 
 # Requirements
 
-<%- if config[:rails] -%>
+<%- if config.fetch(:create).fetch(:rails) -%>
 0. [Ruby on Rails](http://rubyonrails.org).
 <%- end -%>
 
 # Setup
 
-<%- if config[:security] -%>
+<%- if config.fetch(:create).fetch(:security) -%>
 For a secure install, type the following (recommended):
 
     gem cert --add <(curl -Ls http://www.my-website.com/gem-public.pem)
-    gem install <%= config[:gem_name] %> --trust-policy MediumSecurity
+    gem install <%= config.fetch(:gem).fetch(:name) %> --trust-policy MediumSecurity
 
 NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
 allowing the installation of unsigned dependencies since they are beyond the scope of this gem.
 
 For an insecure install, type the following (not recommended):
 
-    gem install <%= config[:gem_name] %>
+    gem install <%= config.fetch(:gem).fetch(:name) %>
 <%- else -%>
 To install, type the following:
 
-    gem install <%= config[:gem_name] %>
+    gem install <%= config.fetch(:gem).fetch(:name) %>
 <%- end -%>
 
-<%- if config[:rails] -%>
+<%- unless config.fetch(:create).fetch(:cli) -%>
 Add the following to your Gemfile:
 
-    gem "<%= config[:gem_name] %>"
+    gem "<%= config.fetch(:gem).fetch(:name) %>"
 <%- end -%>
 
 # Usage
 
-<%- if config[:rspec] -%>
+<%- if config.fetch(:create).fetch(:rspec) -%>
 # Tests
 
 To test, run:
 
-    bundle exec rspec spec
+    bundle exec rake
 <%- end -%>
 
 # Versioning
@@ -78,7 +81,7 @@ Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 # License
 
-Copyright (c) <%= config[:year] %> [<%= config[:company_name] %>](<%= config[:company_url] %>).
+Copyright (c) <%= config.fetch :year %> [<%= config.fetch(:organization).fetch(:name) %>](<%= config.fetch(:organization).fetch(:url) %>).
 Read the [LICENSE](LICENSE.md) for details.
 
 # History
@@ -88,4 +91,4 @@ Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
 
 # Credits
 
-Developed by [<%= config[:author_name] %>](<%= config[:author_url] %>) at [<%= config[:company_name] %>](<%= config[:company_url] %>).
+Developed by [<%= config.fetch(:author).fetch(:name) %>](<%= config.fetch(:author).fetch(:url) %>) at [<%= config.fetch(:organization).fetch(:name) %>](<%= config.fetch(:organization).fetch(:url) %>).