create-ruby-app 1.0.0

checksums.yaml

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Mathias Jean Johansen
+
+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/README.md

@@ -0,0 +1,50 @@
+# Create Ruby App
+[![Build Status](https://travis-ci.org/majjoha/create-ruby-app.svg)](https://travis-ci.org/majjoha/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.
+
+## Requirements
+* Ruby (version 2.6.0 or newer).
+
+## Installation
+```
+gem install create-ruby-app
+```
+
+## Usage
+```
+create-ruby-app new NAME [--ruby RUBY] [--gems GEMS]
+```
+
+### Example
+```
+create-ruby-app new my-app --gems sinatra,sequel --ruby ruby-2.6.1
+```
+
+This will generate the following project structure with
+[Sinatra](http://sinatrarb.com) and [Sequel](http://sequel.jeremyevans.net)
+added to the Gemfile.
+
+```
+my_app
+├── bin/
+│   └── my_app
+├── lib/
+│   ├── my_app/
+│   └── my_app.rb
+├── spec/
+│   ├── lib/
+│   │   └── my_app/
+│   └── spec_helper.rb
+├── .ruby-version
+└── Gemfile
+```
+
+Once the project is generated, it will run `bundle install` so you can start
+working.
+
+## License
+See [LICENSE](https://github.com/majjoha/create-ruby-app/blob/master/LICENSE).

data/bin/create-ruby-app

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require_relative "../lib/create_ruby_app"
+
+CreateRubyApp::CLI.start

data/lib/create_ruby_app/app.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module CreateRubyApp
+  class App
+    def initialize(
+      name: "app",
+      gems: [],
+      version: RUBY_VERSION,
+      logger: Logger.new(STDOUT)
+    )
+      @name = name
+      @gems = gems
+      @version = version
+      @logger = logger
+    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!")
+    end
+
+    def classify_name
+      name.split("_").collect(&:capitalize).join
+    end
+
+    attr_accessor :name, :gems, :version, :logger
+
+    RUBY_VERSION = "ruby-2.6.0"
+
+    private
+
+    def with_logger(text, callable = false)
+      logger.info(text)
+      file_generator.method(callable).call if callable
+    end
+
+    def file_generator
+      @file_generator ||= FileGenerator.new(app: self)
+    end
+  end
+end

data/lib/create_ruby_app/cli.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module CreateRubyApp
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "version", "Print the current version and exit"
+    map %w[--version -v] => :version
+    def version
+      say VERSION
+    end
+
+    desc "new [NAME] [--ruby RUBY] [--gems GEMS]", "Generate new app"
+    long_desc <<~DESC
+      `create-ruby-app new NAME` will generate an app with the provided name.
+
+      Examples:
+        \x5$ create-ruby-app new my_app
+        \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")
+    def new(name)
+      App.new(
+        name: replace_dashes_with_underscores(name),
+        gems: options[:gems].split(","),
+        version: options[:ruby]
+      ).run!
+    end
+
+    private
+
+    def replace_dashes_with_underscores(name)
+      name.tr("-", "_")
+    end
+  end
+end

data/lib/create_ruby_app/file_generator.rb

@@ -0,0 +1,88 @@
+# 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/lib/create_ruby_app/templates/Gemfile.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+group :test, :development do
+  gem "rspec"
+end
+<% unless locals[:gems].empty? %>
+
+<%= locals[:gems].map {|gem| "gem \"#{gem}\"" }.join("\n") %>
+
+<% end %>

data/lib/create_ruby_app/templates/lib_file.erb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module <%= locals[:app] %>
+  class <%= locals[:app] %>
+  end
+end

data/lib/create_ruby_app/templates/ruby-version.erb

@@ -0,0 +1 @@
+<%= locals[:version] %>

data/lib/create_ruby_app/templates/script_file.erb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true

data/lib/create_ruby_app/templates/spec_helper.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "rspec"
+require_relative "../lib/<%= locals[:app] %>"
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) do |c|
+    c.syntax = :expect
+  end
+end

data/lib/create_ruby_app/version.rb

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

data/lib/create_ruby_app.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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"
+
+module CreateRubyApp
+  class CreateRubyApp
+  end
+end

data/spec/lib/create_ruby_app/app_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "../../spec_helper"
+
+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") }
+
+      it "removes the underscores and capitalizes each word" do
+        expect(app.classify_name).to eq("FooBarBaz")
+      end
+    end
+
+    context "when the name of the app contains no underscores" do
+      let(:app) { described_class.new(name: "foobar") }
+
+      it "capitalizes the name" do
+        expect(app.classify_name).to eq("Foobar")
+      end
+    end
+  end
+end

data/spec/lib/create_ruby_app/file_generator_spec.rb

@@ -0,0 +1,138 @@
+# 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

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rspec"
+
+require_relative "../lib/create_ruby_app"
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: create-ruby-app
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mathias Jean Johansen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+description: |-
+  create-ruby-app is an opinionated tool for scaffolding Ruby
+    applications
+email: mathias@mjj.io
+executables:
+- create-ruby-app
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/create-ruby-app
+- lib/create_ruby_app.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/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:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+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/app_spec.rb