create-ruby-app 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 769d91354db227cdf9f8e82610666d2ba473e5f559e36708df0841850d1c777c
-  data.tar.gz: 28eb12ac49e3334ffa4757b74793ac3b9081115c75dc4ab6a45c5b75e2b9ccd2
+  metadata.gz: ff8d6584b0b8947926a85ec594f77b14b2a2cd20c1257fa84a9eb340c8031082
+  data.tar.gz: 1d70581a447648a128dd208840c8faa709a1e7b7bfe51780cb3f4e0457716569
 SHA512:
-  metadata.gz: 4ca234dfc8161a2f6335905e8898e3c3697e9eb736aeb7b7cd5e8f2c240cb212232b690eeb1fb395ffb7ce5a195e5631d7dd56ff1bfabe32f1a07e51b09b8381
-  data.tar.gz: 0e26c8a4e941063b07d4bf8d64d147d0d462efb214b874ea5d81fca0a3bdc0b665d9cbb903372d0068585cab063f078924590cb53840e202b0b2ac872689bd83
+  metadata.gz: af116d9f492b893d3bc020800330c4e84d76f13f69e0112286aa0170511ced20bc81e177732a3813f158acb5448115c1d0bd4ddcf752f2cdc0f13a753cb0d428
+  data.tar.gz: 459e38e43ad058ba50b916b57d7f8262507821a85db7b4b26e05135522ccfe08d9a9849868552021d9f8ed18f7f13f726a3bd62fc9f382464d00cbd99146eade

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# 1.1.0
+- Disable monkey patching for RSpec.
+- Bump Ruby version to 2.6.2.
+- Improve safety of `system` call.
+- Add descriptions to command line arguments.
+
+# 1.0.0
+Initial release.

data/README.md

@@ -1,13 +1,20 @@
 # Create Ruby App
 [![Build Status](https://travis-ci.org/majjoha/create-ruby-app.svg)](https://travis-ci.org/majjoha/create-ruby-app)
+[![Gem Version](https://badge.fury.io/rb/create-ruby-app.svg)](http://badge.fury.io/rb/create-ruby-app)
 
 `create-ruby-app` is an opinionated tool for scaffolding Ruby applications
 effortlessly inspired by [Create React
 App](https://github.com/facebook/create-react-app). It generates only the
 essentials needed to start working.
 
+It specifically targets non-Rails applications. For Ruby on Rails apps, it might
+be worth looking into [Rails Application
+Templates](https://guides.rubyonrails.org/rails_application_templates.html)
+instead, and if you are building a gem, please take a look at the `bundle gem`
+command.
+
 ## Requirements
-* Ruby (version 2.6.0 or newer).
+* Ruby (version 2.6.2 or newer).
 
 ## Installation
 ```

data/lib/create_ruby_app.rb

@@ -2,8 +2,12 @@
 
 require_relative "create_ruby_app/app"
 require_relative "create_ruby_app/cli"
-require_relative "create_ruby_app/file_generator"
 require_relative "create_ruby_app/version"
+require_relative "create_ruby_app/actions/create_directories"
+require_relative "create_ruby_app/actions/generate_files"
+require_relative "create_ruby_app/actions/install_gems"
+require_relative "create_ruby_app/actions/make_script_executable"
+require_relative "create_ruby_app/actions/null_action"
 
 module CreateRubyApp
   class CreateRubyApp

data/lib/create_ruby_app/actions/create_directories.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "pathname"
+
+module CreateRubyApp
+  module Actions
+    class CreateDirectories
+      def self.call(app)
+        [
+          Pathname.new("#{app.name}/bin"),
+          Pathname.new("#{app.name}/lib/#{app.name}"),
+          Pathname.new("#{app.name}/spec/lib/#{app.name}")
+        ].each(&FileUtils.method(:mkdir_p))
+      end
+    end
+  end
+end

data/lib/create_ruby_app/actions/generate_files.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "erb"
+require "pathname"
+
+module CreateRubyApp
+  module Actions
+    class GenerateFiles
+      def initialize(app)
+        @app = app
+      end
+
+      def self.call(app)
+        new(app).call
+      end
+
+      def call
+        generate_files
+      end
+
+      def script_file
+        generate_file(file: "script_file.erb", locals: {})
+      end
+
+      def lib_file
+        generate_file(file: "lib_file.erb", locals: { app: app.classify_name })
+      end
+
+      def spec_helper_file
+        generate_file(file: "spec_helper.erb", locals: { app: app.name })
+      end
+
+      def ruby_version_file
+        generate_file(
+          file: "ruby-version.erb",
+          locals: { version: app.version }
+        )
+      end
+
+      def gemfile
+        generate_file(file: "Gemfile.erb", locals: { gems: app.gems.sort })
+      end
+
+      private
+
+      attr_reader :app
+
+      def generate_files
+        files.each {|path, content| create_file(path: path, content: content) }
+      end
+
+      def create_file(path:, content:)
+        File.write("#{app.name}/#{path}", content)
+      end
+
+      def generate_file(file:, locals: [])
+        ERB
+          .new(read_file(file), trim_mode: TRIM_MODE)
+          .result_with_hash(locals: locals)
+      end
+
+      def read_file(file)
+        Pathname.new(__FILE__)
+          .dirname
+          .join("#{TEMPLATES_DIR}/#{file}")
+          .read
+      end
+
+      def files
+        {
+          "bin/#{app.name}" => script_file,
+          "lib/#{app.name}.rb" => lib_file,
+          "spec/spec_helper.rb" => spec_helper_file,
+          ".ruby-version" => ruby_version_file,
+          "Gemfile" => gemfile
+        }
+      end
+
+      TRIM_MODE = "<>"
+      TEMPLATES_DIR = "../templates"
+    end
+  end
+end

data/lib/create_ruby_app/actions/install_gems.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CreateRubyApp
+  module Actions
+    class InstallGems
+      def self.call(app)
+        Dir.chdir(app.name) { system("bundle", "install") }
+      end
+    end
+  end
+end

data/lib/create_ruby_app/actions/make_script_executable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module CreateRubyApp
+  module Actions
+    class MakeScriptExecutable
+      def self.call(app)
+        FileUtils.chmod("+x", "#{app.name}/bin/#{app.name}")
+      end
+    end
+  end
+end

data/lib/create_ruby_app/actions/null_action.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CreateRubyApp
+  module Actions
+    class NullAction
+      def self.call(app); end
+    end
+  end
+end

data/lib/create_ruby_app/app.rb

@@ -17,30 +17,26 @@ module CreateRubyApp
     end
 
     def run!
-      with_logger("Creating directories...", :create_directories)
-      with_logger("Generating files...", :generate_files)
-      with_logger("Making script executable...", :make_script_executable)
-      with_logger("Installing gems...", :install_gems)
-      with_logger("Happy hacking!")
+      with_logger("Creating directories...", Actions::CreateDirectories)
+      with_logger("Generating files...", Actions::GenerateFiles)
+      with_logger("Making script executable...", Actions::MakeScriptExecutable)
+      with_logger("Installing gems...", Actions::InstallGems)
+      with_logger("Happy hacking!", Actions::NullAction)
     end
 
     def classify_name
       name.split("_").collect(&:capitalize).join
     end
 
-    attr_accessor :name, :gems, :version, :logger
+    attr_reader :name, :gems, :version, :logger
 
-    RUBY_VERSION = "ruby-2.6.0"
+    RUBY_VERSION = "ruby-2.6.2"
 
     private
 
-    def with_logger(text, callable = false)
+    def with_logger(text, action)
       logger.info(text)
-      file_generator.method(callable).call if callable
-    end
-
-    def file_generator
-      @file_generator ||= FileGenerator.new(app: self)
+      action.call(self)
     end
   end
 end

data/lib/create_ruby_app/cli.rb

@@ -23,9 +23,18 @@ module CreateRubyApp
         \x5$ create-ruby-app new -g sinatra,sequel -r ruby-2.6.0 web_app
         \x5$ create-ruby-app new --ruby jruby-2.9.6.0 my_app
     DESC
-
-    method_option(:ruby, default: App::RUBY_VERSION, aliases: "-r")
-    method_option(:gems, default: "", aliases: "-g")
+    method_option(
+      :ruby,
+      aliases: "-r",
+      desc: "Specify which Ruby version to use for the project",
+      default: App::RUBY_VERSION
+    )
+    method_option(
+      :gems,
+      aliases: "-g",
+      desc: "Specify which gems to add to the project",
+      default: ""
+    )
     def new(name)
       App.new(
         name: replace_dashes_with_underscores(name),

data/lib/create_ruby_app/templates/spec_helper.erb

@@ -7,4 +7,6 @@ RSpec.configure do |config|
   config.expect_with(:rspec) do |c|
     c.syntax = :expect
   end
+
+  config.disable_monkey_patching!
 end

data/lib/create_ruby_app/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CreateRubyApp
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/lib/create_ruby_app/actions/create_directories_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "../../../spec_helper"
+
+RSpec.describe CreateRubyApp::Actions::CreateDirectories do
+  describe ".call" do
+    let(:app) { instance_double("app", name: "foo_bar") }
+    let(:action) { described_class }
+
+    it "creates the directories" do
+      allow(FileUtils).to receive(:mkdir_p)
+
+      action.call(app)
+
+      expect(FileUtils).to have_received(:mkdir_p).exactly(3).times
+    end
+  end
+end

data/spec/lib/create_ruby_app/actions/generate_files_spec.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require_relative "../../../spec_helper"
+
+RSpec.describe CreateRubyApp::Actions::GenerateFiles do
+  describe "#generate_gemfile" do
+    context "when no additional gems are added" do
+      let(:app) { instance_double("app", gems: []) }
+      let(:action) { described_class.new(app) }
+      let(:gemfile) do
+        <<~GEMFILE
+          # frozen_string_literal: true
+
+          source "https://rubygems.org"
+
+          group :test, :development do
+            gem "rspec"
+          end
+        GEMFILE
+      end
+
+      it "produces a Gemfile without any additional gems" do
+        expect(action.gemfile).to eq(gemfile)
+      end
+    end
+
+    context "when additional gems are added" do
+      let(:app) { instance_double("app", gems: %w[sinatra sqlite]) }
+      let(:action) { described_class.new(app) }
+      let(:gemfile) do
+        <<~GEMFILE
+          # frozen_string_literal: true
+
+          source "https://rubygems.org"
+
+          group :test, :development do
+            gem "rspec"
+          end
+
+          gem "sinatra"
+          gem "sqlite"
+        GEMFILE
+      end
+
+      it "produces a Gemfile with the gems" do
+        expect(action.gemfile).to eq(gemfile)
+      end
+    end
+  end
+
+  describe "#generate_ruby_version_file" do
+    context "when no version is specified" do
+      let(:app) do
+        instance_double("app", version: CreateRubyApp::App::RUBY_VERSION)
+      end
+      let(:action) { described_class.new(app) }
+
+      it { expect(action.ruby_version_file).to eq("ruby-2.6.2") }
+    end
+
+    context "when a version is specified" do
+      let(:app) { instance_double("app", version: "ruby-2.5.0") }
+      let(:action) { described_class.new(app) }
+
+      it { expect(action.ruby_version_file).to eq("ruby-2.5.0") }
+    end
+  end
+
+  describe "#generate_lib_file" do
+    context "when generating a lib file" do
+      let(:app) { instance_double("app") }
+      let(:action) { described_class.new(app) }
+      let(:lib_file) do
+        <<~LIB_FILE
+          # frozen_string_literal: true
+
+          module ThisIsAnApp
+            class ThisIsAnApp
+            end
+          end
+        LIB_FILE
+      end
+
+      it "fills out a lib file with the correct module and class name" do
+        allow(app).to receive(:classify_name).and_return("ThisIsAnApp")
+
+        expect(action.lib_file).to eq(lib_file)
+      end
+    end
+  end
+
+  describe "#generate_spec_helper_file" do
+    context "when generating a spec helper file" do
+      let(:app) { instance_double("app", name: "this_is_an_app") }
+      let(:action) { described_class.new(app) }
+      let(:spec_helper) do
+        <<~SPEC_HELPER
+          # frozen_string_literal: true
+
+          require "rspec"
+          require_relative "../lib/this_is_an_app"
+
+          RSpec.configure do |config|
+            config.expect_with(:rspec) do |c|
+              c.syntax = :expect
+            end
+
+            config.disable_monkey_patching!
+          end
+        SPEC_HELPER
+      end
+
+      it "fills out the file and references the app" do
+        expect(action.spec_helper_file).to eq(spec_helper)
+      end
+    end
+  end
+
+  describe "#generate_script_file" do
+    context "when generating an executable script file" do
+      let(:app) { instance_double("app") }
+      let(:action) { described_class.new(app) }
+      let(:script_file) do
+        <<~SCRIPT_FILE
+          #!/usr/bin/env ruby
+
+          # frozen_string_literal: true
+        SCRIPT_FILE
+      end
+
+      it "fills out a default script file template" do
+        expect(action.script_file).to eq(script_file)
+      end
+    end
+  end
+end

data/spec/lib/create_ruby_app/actions/install_gems_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "../../../spec_helper"
+
+RSpec.describe CreateRubyApp::Actions::InstallGems do
+  describe ".call" do
+    let(:app) { instance_double("app", name: "foo_bar") }
+    let(:action) { described_class }
+
+    it "installs the gems" do
+      allow(Dir).to receive(:chdir).with("foo_bar")
+
+      action.call(app)
+
+      expect(Dir).to have_received(:chdir).with("foo_bar")
+    end
+  end
+end

data/spec/lib/create_ruby_app/actions/make_script_executable_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "../../../spec_helper"
+
+RSpec.describe CreateRubyApp::Actions::MakeScriptExecutable do
+  describe ".call" do
+    let(:app) { instance_double("app", name: "foo_bar") }
+    let(:action) { described_class }
+
+    it "creates the directories" do
+      allow(FileUtils).to receive(:chmod).with("+x", "foo_bar/bin/foo_bar")
+
+      action.call(app)
+
+      expect(FileUtils).to(
+        have_received(:chmod).with("+x", "foo_bar/bin/foo_bar")
+      )
+    end
+  end
+end

data/spec/lib/create_ruby_app/app_spec.rb

@@ -2,7 +2,7 @@
 
 require_relative "../../spec_helper"
 
-describe CreateRubyApp::App do
+RSpec.describe CreateRubyApp::App do
   describe "#classify_name" do
     context "when the name of the app contains underscores" do
       let(:app) { described_class.new(name: "foo_bar_baz") }

data/spec/spec_helper.rb

@@ -8,4 +8,6 @@ RSpec.configure do |config|
   config.expect_with(:rspec) do |c|
     c.syntax = :expect
   end
+
+  config.disable_monkey_patching!
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: create-ruby-app
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mathias Jean Johansen
@@ -61,21 +61,29 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - bin/create-ruby-app
 - lib/create_ruby_app.rb
+- lib/create_ruby_app/actions/create_directories.rb
+- lib/create_ruby_app/actions/generate_files.rb
+- lib/create_ruby_app/actions/install_gems.rb
+- lib/create_ruby_app/actions/make_script_executable.rb
+- lib/create_ruby_app/actions/null_action.rb
 - lib/create_ruby_app/app.rb
 - lib/create_ruby_app/cli.rb
-- lib/create_ruby_app/file_generator.rb
 - lib/create_ruby_app/templates/Gemfile.erb
 - lib/create_ruby_app/templates/lib_file.erb
 - lib/create_ruby_app/templates/ruby-version.erb
 - lib/create_ruby_app/templates/script_file.erb
 - lib/create_ruby_app/templates/spec_helper.erb
 - lib/create_ruby_app/version.rb
+- spec/lib/create_ruby_app/actions/create_directories_spec.rb
+- spec/lib/create_ruby_app/actions/generate_files_spec.rb
+- spec/lib/create_ruby_app/actions/install_gems_spec.rb
+- spec/lib/create_ruby_app/actions/make_script_executable_spec.rb
 - spec/lib/create_ruby_app/app_spec.rb
-- spec/lib/create_ruby_app/file_generator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/majjoha/create-ruby-app
 licenses:
@@ -96,11 +104,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Scaffold Ruby applications effortlessly
 test_files:
 - spec/spec_helper.rb
-- spec/lib/create_ruby_app/file_generator_spec.rb
+- spec/lib/create_ruby_app/actions/make_script_executable_spec.rb
+- spec/lib/create_ruby_app/actions/create_directories_spec.rb
+- spec/lib/create_ruby_app/actions/generate_files_spec.rb
+- spec/lib/create_ruby_app/actions/install_gems_spec.rb
 - spec/lib/create_ruby_app/app_spec.rb

data/lib/create_ruby_app/file_generator.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-require "fileutils"
-require "pathname"
-
-module CreateRubyApp
-  class FileGenerator
-    def initialize(app: App.new)
-      @app = app
-    end
-
-    def generate_gemfile
-      generate_file(file: "Gemfile.erb", locals: { gems: app.gems.sort })
-    end
-
-    def generate_lib_file
-      generate_file(file: "lib_file.erb", locals: { app: app.classify_name })
-    end
-
-    def generate_ruby_version_file
-      generate_file(file: "ruby-version.erb", locals: { version: app.version })
-    end
-
-    def generate_script_file
-      generate_file(file: "script_file.erb", locals: {})
-    end
-
-    def generate_spec_helper_file
-      generate_file(file: "spec_helper.erb", locals: { app: app.name })
-    end
-
-    def create_directories
-      directories.each(&FileUtils.method(:mkdir_p))
-    end
-
-    def generate_files
-      files.each {|path, content| create_file(path: path, content: content) }
-    end
-
-    def make_script_executable
-      FileUtils.chmod("+x", "#{app.name}/bin/#{app.name}")
-    end
-
-    def install_gems
-      system("cd #{app.name} && bundle install")
-    end
-
-    private
-
-    attr_accessor :app
-
-    def generate_file(file:, locals: [])
-      ERB
-        .new(read_file(file), trim_mode: TRIM_MODE)
-        .result_with_hash(locals: locals)
-    end
-
-    def read_file(file)
-      Pathname.new(__FILE__).dirname.join("#{TEMPLATES_DIR}/#{file}").read
-    end
-
-    def create_file(path:, content:)
-      File.write("#{app.name}/#{path}", content)
-    end
-
-    def files
-      {
-        "bin/#{app.name}" => generate_script_file,
-        "lib/#{app.name}.rb" => generate_lib_file,
-        "spec/spec_helper.rb" => generate_spec_helper_file,
-        ".ruby-version" => generate_ruby_version_file,
-        "Gemfile" => generate_gemfile
-      }
-    end
-
-    def directories
-      [
-        Pathname.new("#{app.name}/bin"),
-        Pathname.new("#{app.name}/lib/#{app.name}"),
-        Pathname.new("#{app.name}/spec/lib/#{app.name}")
-      ]
-    end
-
-    TEMPLATES_DIR = "templates"
-    TRIM_MODE = "<>"
-  end
-end

data/spec/lib/create_ruby_app/file_generator_spec.rb

@@ -1,138 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../spec_helper"
-
-describe CreateRubyApp::FileGenerator do
-  describe "#generate_gemfile" do
-    context "when no additional gems are added" do
-      let(:file_generator) { described_class.new }
-
-      it "produces a Gemfile without any additional gems" do
-        expect(file_generator.generate_gemfile).to eq(
-          <<~GEMFILE
-            # frozen_string_literal: true
-
-            source "https://rubygems.org"
-
-            group :test, :development do
-              gem "rspec"
-            end
-          GEMFILE
-        )
-      end
-    end
-
-    context "when additional gems are added" do
-      let(:app) { instance_double("app") }
-      let(:file_generator) { described_class.new(app: app) }
-
-      it "produces a Gemfile with the gems" do
-        allow(app).to receive(:gems).and_return(%w[sinatra sqlite])
-
-        expect(file_generator.generate_gemfile).to eq(
-          <<~GEMFILE
-            # frozen_string_literal: true
-
-            source "https://rubygems.org"
-
-            group :test, :development do
-              gem "rspec"
-            end
-
-            gem "sinatra"
-            gem "sqlite"
-          GEMFILE
-        )
-      end
-    end
-  end
-
-  describe "#generate_ruby_version_file" do
-    context "when no version is specified" do
-      let(:app) { instance_double("app") }
-      let(:file_generator) { described_class.new(app: app) }
-
-      it "uses version 2.6.0 as default" do
-        allow(app).to receive(:version).and_return("ruby-2.6.0")
-
-        expect(file_generator.generate_ruby_version_file).to eq("ruby-2.6.0")
-      end
-    end
-
-    context "when a version is specified" do
-      let(:app) { instance_double("app") }
-      let(:file_generator) { described_class.new(app: app) }
-
-      it "uses the version in the .ruby-version file" do
-        allow(app).to receive(:version).and_return("ruby-2.5.0")
-
-        expect(file_generator.generate_ruby_version_file).to eq("ruby-2.5.0")
-      end
-    end
-  end
-
-  describe "#generate_lib_file" do
-    context "when generating a lib file" do
-      let(:app) { instance_double("app") }
-      let(:file_generator) { described_class.new(app: app) }
-
-      it "fills out a lib file with the correct module and class name" do
-        allow(app).to receive(:name).and_return("this_is_an_app")
-        allow(app).to receive(:classify_name).and_return("ThisIsAnApp")
-
-        expect(file_generator.generate_lib_file).to eq(
-          <<~LIB_FILE
-            # frozen_string_literal: true
-
-            module ThisIsAnApp
-              class ThisIsAnApp
-              end
-            end
-          LIB_FILE
-        )
-      end
-    end
-  end
-
-  describe "#generate_spec_helper_file" do
-    context "when generating a spec helper file" do
-      let(:app) { instance_double("app") }
-      let(:file_generator) { described_class.new(app: app) }
-
-      it "fills out the file and references the app" do
-        allow(app).to receive(:name).and_return("this_is_an_app")
-
-        expect(file_generator.generate_spec_helper_file).to eq(
-          <<~SPEC_HELPER
-            # frozen_string_literal: true
-
-            require "rspec"
-            require_relative "../lib/this_is_an_app"
-
-            RSpec.configure do |config|
-              config.expect_with(:rspec) do |c|
-                c.syntax = :expect
-              end
-            end
-          SPEC_HELPER
-        )
-      end
-    end
-  end
-
-  describe "#generate_script_file" do
-    context "when generating an executable script file" do
-      let(:file_generator) { described_class.new }
-
-      it "fills out a default script file template" do
-        expect(file_generator.generate_script_file).to eq(
-          <<~SCRIPT_FILE
-            #!/usr/bin/env ruby
-
-            # frozen_string_literal: true
-          SCRIPT_FILE
-        )
-      end
-    end
-  end
-end