gemaker 0.1.3 → 0.6.0

data/lib/gemaker/commands/configure_travis.rb

@@ -0,0 +1,15 @@
+module Gemaker
+  module Cmd
+    class ConfigureTravis < Gemaker::Cmd::Base
+      def in_normal_context
+        copy_template("normal/travis.yml", ".travis.yml", config: @config)
+        info "Configure Tavis"
+      end
+
+      def in_engine_context
+        copy_template("engine/travis.yml", ".travis.yml", config: @config)
+        info "Configure Tavis"
+      end
+    end
+  end
+end

data/lib/gemaker/commands/create_gem.rb

@@ -0,0 +1,45 @@
+module Gemaker
+  module Cmd
+    class CreateGem < Gemaker::Cmd::Base
+      def in_engine_context
+        mountable_opt = "--mountable" if @config.mountable?
+
+        commands = [
+          "echo \"source 'https://rubygems.org'\" > GemakerGemfile",
+          "echo \"gem 'rails', '~> #{Gemaker::RAILS_VERSION}'\" > GemakerGemfile",
+          "BUNDLE_GEMFILE=GemakerGemfile bundle install",
+          "BUNDLE_GEMFILE=GemakerGemfile bundle exec rails plugin new #{@config.gem_name} -T #{mountable_opt} --dummy-path=spec/dummy", # rubocop:disable Metrics/LineLength
+          "rm -f GemakerGemfile GemakerGemfile.lock"
+        ]
+
+        create_customized_gem(commands.join('; '))
+      end
+
+      def in_normal_context
+        create_customized_gem("bundle gem #{@config.gem_name}")
+      end
+
+      private
+
+      # rubocop:disable Metrics/MethodLength
+      def create_customized_gem(cmd)
+        execute(cmd)
+        Gemaker::Cmd::AddReadme.for(config: @config)
+        Gemaker::Cmd::AddChangelog.for(config: @config)
+        Gemaker::Cmd::CustomizeGemspec.for(config: @config)
+        Gemaker::Cmd::AddLicense.for(config: @config)
+        Gemaker::Cmd::AddCliStructure.for(config: @config)
+        Gemaker::Cmd::ConfigureTestEnv.for(config: @config)
+        Gemaker::Cmd::AddRubyVersion.for(config: @config)
+        Gemaker::Cmd::CustomizeEngine.for(config: @config)
+        Gemaker::Cmd::CustomizeRakefile.for(config: @config)
+        Gemaker::Cmd::CustomizeMainLibFile.for(config: @config)
+        Gemaker::Cmd::AddInstallGenerator.for(config: @config)
+        Gemaker::Cmd::AddHoundRules.for(config: @config)
+        Gemaker::Cmd::ConfigureTravis.for(config: @config)
+        Gemaker::Cmd::ConfigureGit.for(config: @config)
+        info("Done!")
+      end
+    end
+  end
+end

data/lib/gemaker/commands/customize_engine.rb

@@ -0,0 +1,13 @@
+module Gemaker
+  module Cmd
+    class CustomizeEngine < Gemaker::Cmd::Base
+      def in_engine_context
+        copy_template("engine/engine.rb",
+          "lib/#{@config.gem_name}/engine.rb", config: @config)
+        copy_template("engine/example_class.rb",
+          "lib/#{@config.gem_name}/example_class.rb", config: @config)
+        info "Customize engine.rb"
+      end
+    end
+  end
+end

data/lib/gemaker/commands/customize_gemspec.rb

@@ -0,0 +1,20 @@
+module Gemaker
+  module Cmd
+    class CustomizeGemspec < Gemaker::Cmd::Base
+      def in_normal_context
+        copy_gempsec("normal/gemspec")
+      end
+
+      def in_engine_context
+        copy_gempsec("engine/gemspec")
+      end
+
+      private
+
+      def copy_gempsec(template)
+        copy_template(template, "#{@config.gem_name}.gemspec", config: @config)
+        info "Customize #{@config.gem_name}.gemspec"
+      end
+    end
+  end
+end

data/lib/gemaker/commands/customize_main_lib_file.rb

@@ -0,0 +1,10 @@
+module Gemaker
+  module Cmd
+    class CustomizeMainLibFile < Gemaker::Cmd::Base
+      def in_engine_context
+        copy_template("engine/lib_main_file.rb", "lib/#{@config.gem_name}.rb", config: @config)
+        info "Customize \"lib/#{@config.gem_name}.rb\""
+      end
+    end
+  end
+end

data/lib/gemaker/commands/customize_rakefile.rb

@@ -0,0 +1,20 @@
+module Gemaker
+  module Cmd
+    class CustomizeRakefile < Gemaker::Cmd::Base
+      def in_normal_context
+        customize_rakefile("normal/Rakefile")
+      end
+
+      def in_engine_context
+        customize_rakefile("engine/Rakefile")
+      end
+
+      private
+
+      def customize_rakefile(template)
+        copy_file(template, "Rakefile")
+        info "Customize Rakefile"
+      end
+    end
+  end
+end

data/lib/gemaker/config.rb

@@ -0,0 +1,66 @@
+module Gemaker
+  class Config
+    RUBY_VERSION = 2.3
+
+    attr_accessor :gem_name, :summary, :engine, :cli, :mountable, :installable
+    attr_reader :authors, :emails
+    attr_writer :human_gem_name, :description, :homepage
+
+    def initialize
+      self.engine = :normal
+    end
+
+    def human_gem_name
+      return gem_name.titleize if @human_gem_name.blank?
+      @human_gem_name
+    end
+
+    def gem_class
+      gem_name.classify
+    end
+
+    def description
+      return summary if @description.blank?
+      @description
+    end
+
+    def homepage
+      return "https://github.com/platanus/#{gem_name}/master" if @homepage.blank?
+      @homepage
+    end
+
+    def authors=(value)
+      @authors = ["Platanus"] + string_to_array(value)
+    end
+
+    def emails=(value)
+      @emails = ["rubygems@platan.us"] + string_to_array(value)
+    end
+
+    def engine?
+      !!engine
+    end
+
+    def cli?
+      !!cli
+    end
+
+    def mountable?
+      !!mountable
+    end
+
+    def installable?
+      !!installable
+    end
+
+    def ruby_version
+      RUBY_VERSION
+    end
+
+    private
+
+    def string_to_array(value)
+      value.split(",").map(&:strip).reject(&:blank?)
+    end
+  end
+end

data/lib/gemaker/templates/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v0.1.0
+
+* Initial release.

data/lib/gemaker/templates/LICENSE.txt.erb

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright <%= Time.now.year %> Platanus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/gemaker/templates/cli.rb.erb

@@ -0,0 +1,19 @@
+module <%= config.gem_class %>
+  class Cli
+    include Commander::Methods
+
+    def run
+      program :name, "<%= config.human_gem_name %>"
+      program :version, <%= config.gem_class %>::VERSION
+      program :description, "<%= config.description.blank? ? "TODO: add description" : config.description %>"
+
+      command("hello") do |c|
+        c.syntax = "<%= config.gem_name %> hello"
+        c.description = "Just a command example"
+        c.action { puts "Hello Platanus!" }
+      end
+
+      run!
+    end
+  end
+end

data/lib/gemaker/templates/coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/lib/gemaker/templates/engine/Guardfile

@@ -0,0 +1,15 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  spec_dic = "spec/dummy/spec"
+  # RSpec files
+  watch("spec/spec_helper.rb") { spec_dic }
+  watch("spec/rails_helper.rb") { spec_dic }
+  watch(%r{^spec\/dummy\/spec\/support\/(.+)\.rb$}) { spec_dic }
+  watch(%r{^spec\/dummy\/spec\/.+_spec\.rb$})
+  # Engine files
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/dummy/spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.+)\.rb$}) { |m| "spec/dummy/spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb)$}) { |m| "spec/dummy/spec/#{m[1]}#{m[2]}_spec.rb" }
+  # Dummy app files
+  watch(%r{^spec\/dummy\/app/(.+)\.rb$}) { |m| "spec/dummy/spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec\/dummy\/app/(.*)(\.erb)$}) { |m| "spec/dummy/spec/#{m[1]}#{m[2]}_spec.rb" }
+end

data/lib/gemaker/templates/engine/README.md.erb

@@ -0,0 +1,55 @@
+# <%= config.human_gem_name %>
+
+<%= config.description.blank? ? "TODO" : config.description %>
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "<%= config.gem_name %>"
+```
+
+```bash
+bundle install
+```
+
+Then, run the installer:
+
+```bash
+rails generate <%= @config.gem_name %>:install
+```
+
+## Usage
+
+TODO
+
+## Testing
+
+To run the specs you need to execute, **in the root path of the gem**, the following command:
+
+```bash
+bundle exec guard
+```
+
+You need to put **all your tests** in the `/<%= config.gem_name %>/spec/dummy/spec/` directory.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/<%= config.gem_name %>/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+<%= config.human_gem_name %> is maintained by [platanus](http://platan.us).
+
+## License
+
+<%= config.human_gem_name %> is © <%= Time.now.year %> platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/lib/gemaker/templates/engine/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+Bundler::GemHelper.install_tasks

data/lib/gemaker/templates/engine/engine.rb.erb

@@ -0,0 +1,15 @@
+module <%= config.gem_class %>
+  class Engine < ::Rails::Engine
+    isolate_namespace <%= config.gem_class %>
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_bot, dir: "spec/factories"
+    end
+
+    initializer "initialize" do
+      # Require here all your engine's classes.
+      require_relative "./example_class"
+    end
+  end
+end

data/lib/gemaker/templates/engine/example_class.rb.erb

@@ -0,0 +1,7 @@
+module <%= config.gem_class %>
+  class ExampleClass
+    def self.say_hi
+      "Hello Platanus developer!"
+    end
+  end
+end

data/lib/gemaker/templates/engine/gemspec.erb

@@ -0,0 +1,30 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem"s version:
+require "<%= config.gem_name %>/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name          = "<%= config.gem_name %>"
+  s.version       = <%= config.gem_class %>::VERSION
+  s.authors       = <%= config.authors.to_s %>
+  s.email         = <%= config.emails.to_s %>
+  s.homepage      = "<%= config.homepage %>"
+  s.summary       = "<%= config.summary %>"
+  s.description   = "<%= config.description %>"
+  s.license       = "MIT"
+
+  s.files = `git ls-files`.split($/).reject { |fn| fn.start_with? "spec" }
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_dependency "rails", ">= 4.2.0"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-rails"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "factory_bot_rails"
+  s.add_development_dependency "coveralls"
+end

data/lib/gemaker/templates/engine/gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+coverage/

data/lib/gemaker/templates/engine/initializer.rb.erb

@@ -0,0 +1,2 @@
+<%= config.gem_class %>.setup do |config|
+end

data/lib/gemaker/templates/engine/install_generator.rb.erb

@@ -0,0 +1,21 @@
+class <%= config.gem_class %>::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_initializer
+    template "initializer.rb", "config/initializers/<%= config.gem_name %>.rb"
+  end
+
+<% if config.mountable? -%>
+  def mount_routes
+    line = "Rails.application.routes.draw do\n"
+    inject_into_file "config/routes.rb", after: line do <<-"HERE".gsub(/^ {4}/, '')
+      mount <%= config.gem_class %>::Engine => "/<%= config.gem_name %>"
+    HERE
+    end
+  end
+<% end -%>
+
+  def copy_engine_migrations
+    rake "railties:install:migrations"
+  end
+end

data/lib/gemaker/templates/engine/install_usage.erb

@@ -0,0 +1,5 @@
+Description:
+    Install the engine in host app.
+
+Example:
+    rails generate <%= @config.gem_name %>:install