blueprint 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2e6ce14d37f31768240fe665d81d2c486ad3c84
+  data.tar.gz: 7dcfe99d824c4bb364d1f9267ae387f86f5b9728
+SHA512:
+  metadata.gz: ffb27520a7a3077dbdbfdb9943661e40e842f0232a8a0654ae9c271b5c28b15582aea028a7809758eac564af6f6f2a83ce21517d4111a2d8dbd1be12befa7165
+  data.tar.gz: f14dc34283275d6a2f2bce5e49554f33871b7a95282173cc038a9fd95d8d3d9a4b2eacef49cfdb9c811bcb502d75f17e89bd281920c9ec4bef0f278e82f00351

data/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{js,coffee}]
+indent_size = 4
+
+[*.{css,scss,less}]
+indent_size = 4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundler

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,19 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/Documentation:
+  Enabled: false
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+AllCops:
+  TargetRubyVersion: 2.2
+
+# long script methods
+Metrics/MethodLength:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blueprint.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Datarockets
+
+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,126 @@
+# Blueprint
+
+Blueprint is the Rails application starter used at [datarockets](datarockets.com).
+
+## Installation
+
+TODO: fix it
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blueprint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blueprint
+
+## Usage
+
+For creating rails application run:
+
+    $ blueprint new APP_NAME
+
+### Create custom generator
+
+Guide for creating and editing generators.
+
+#### Step 1: create command for calling generator
+
+Add command for generator in `lib/blueprint/generator/cli.rb`.
+
+Example:
+
+```ruby
+command :new do |c|
+  c.syntax = 'blueprint new APP_PATH'
+  c.summary = 'Generate rails application'
+  c.description = 'Generate rails application with default settings and dependecies'
+  c.action do |args, _options|
+    Blueprint::Generator::RailsApp.new(name: args[0]).run!
+  end
+end
+```
+
+#### Step 2: Create generator class
+
+Extending class of `Blueprint::Generator::Base`:
+
+```ruby
+require 'blueprint/generator/base'
+
+module Blueprint
+  module Generator
+    class RailsApp < Base
+    end
+  end
+end
+```
+
+#### Step 3: Create folder with files
+
+Create folder for files and templates for your application on folder `lib/blueprint/generator/templates/` and override folder name on generator class
+
+```ruby
+def self.template_path
+  'rails_app'
+end
+```
+
+#### Step 4: Create ask question step for generator
+
+Override `ask_questions` method for creating `config` hash. [Question list.](https://github.com/commander-rb/commander#highline)
+
+```ruby
+def ask_questions
+  config[:bootstrap] = agree("Would you like initialize bootstrap on your application?")
+end
+```
+
+#### Step 5: Create generator script
+
+Override `execute` method for creating generator script.
+
+```ruby
+def execute
+  shell "rails new #{name} --skip-bundle --database=postgresql --no-rc --skip-test-unit"
+end
+```
+
+List with commands for creating execute script:
+
+Command | Description | Example
+--- | --- | ---
+`cmd_title(string)` | Puts string on console | `cmd_title('Start script')`
+`shell(cmd)` | Run shell command | `shell('mkdir examples')`
+`cd_path(path)` | Change current path | `cd_path(name)`
+`copy_file(from, to)` | Copy file from templates path to project. If second argument exist, copy file to tepmlates path | `copy_file('.editorconfig')`
+`copy_file_from_template(from, to)` | Copy `erb` file from templates path to project with parsing. If second argument exist, copy file to tepmlates path | `copy_file_from_template('Gemfile')`
+
+Variable lists in generator class and erb templates
+
+Variable | Description
+--- | ---
+name | First argument on running script
+config | Generated on `ask_question` step
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/blueprint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/blueprint

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'blueprint/cli'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'blueprint'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/rspec

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+bundle ex rspec
+bundle ex rubocop

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install --path vendor/bundler
+
+# Do any other automated setup that you need to do here

data/blueprint.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blueprint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'blueprint'
+  spec.version       = Blueprint::VERSION
+  spec.authors       = ['Datarockets']
+  spec.email         = ['hello@datarockets.com']
+
+  spec.summary       = 'Rails application generator'
+  spec.description   = 'Generate application with custom settings'
+  spec.homepage      = 'https://github.com/datarockets/blueprint'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ['blueprint']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  %w(rspec simplecov rubocop pry rails).each do |dependecy|
+    spec.add_development_dependency dependecy
+  end
+
+  %w(commander).each do |dependecy|
+    spec.add_dependency dependecy
+  end
+end

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  post:
+    - bundle exec rubocop

data/lib/blueprint.rb

@@ -0,0 +1,5 @@
+require 'blueprint/version'
+
+module Blueprint
+  # Your code goes here...
+end

data/lib/blueprint/cli.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'commander/import'
+
+require 'blueprint'
+require 'blueprint/generator/rails_app'
+
+program :name, 'blueprint'
+program :version, Blueprint::VERSION
+program :description, 'Rails application starter used at datarockets'
+
+command :new do |c|
+  c.syntax = 'blueprint new APP_PATH'
+  c.summary = 'Generate rails application'
+  c.description = 'Generate rails application with default settings and dependecies'
+  c.action do |args, _options|
+    Blueprint::Generator::RailsApp.new(name: args[0]).run!
+  end
+end

data/lib/blueprint/generator/base.rb

@@ -0,0 +1,65 @@
+require 'blueprint/generator/base/template_rendering'
+
+module Blueprint
+  module Generator
+    class Base
+      attr_reader :name, :config
+
+      def initialize(name:)
+        @name = name
+        @config = {}
+      end
+
+      def run!
+        ask_questions
+        execute
+      end
+
+      def self.template_path
+        ''
+      end
+
+      private
+
+        def ask_questions
+        end
+
+        def execute
+        end
+
+        def shell(cmd)
+          cmd_title("Run #{cmd}")
+          system(cmd)
+        end
+
+        def copy_file(from, to = nil)
+          cmd_title("Copy file #{from}")
+          to = from if to.nil?
+          FileUtils.cp(template_path + from, to)
+        end
+
+        def copy_file_from_template(from, to = nil)
+          cmd_title("Copy file #{from} from template")
+          to = from if to.nil?
+
+          template = TemplateRendering.new(name, config)
+          template.save(template_path + from + '.erb', to)
+        end
+
+        def cd_path(path)
+          cmd_title("Cnahge the current directory to #{path}")
+          FileUtils.cd(path)
+        end
+
+        def template_path
+          File.expand_path(File.dirname(__FILE__)) + '/templates/' + self.class.template_path + '/'
+        end
+
+        def cmd_title(title)
+          puts
+          puts title
+          puts
+        end
+    end
+  end
+end

data/lib/blueprint/generator/base/template_rendering.rb

@@ -0,0 +1,27 @@
+require 'erb'
+
+module Blueprint
+  module Generator
+    class Base
+      class TemplateRendering
+        attr_reader :name, :config
+
+        def initialize(name, config)
+          @name = name
+          @config = config
+        end
+
+        def render(template_file)
+          template = File.open(template_file).read
+          ERB.new(template, 0, '%<>').result(binding)
+        end
+
+        def save(from, to)
+          File.open(to, 'w+') do |f|
+            f.write(render(from))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/blueprint/generator/rails_app.rb

@@ -0,0 +1,44 @@
+require 'blueprint/generator/base'
+
+module Blueprint
+  module Generator
+    class RailsApp < Base
+      def self.template_path
+        'rails_app'
+      end
+
+      private
+
+        def ask_questions
+          config[:title] = ask("Application title: ")
+        end
+
+        def execute
+          cmd_title("Generate rails application with path #{name}")
+
+          # Create application
+          shell "rails new #{name} --skip-bundle --database=postgresql --no-rc --skip-test-unit"
+          cd_path(name)
+
+          # Copy dotfiles
+          copy_file('.editorconfig')
+          copy_file('.gitignore')
+          copy_file('.ruby-version')
+
+          # Create config/examples
+          cmd_title('Create config\'s examples')
+          shell 'mkdir config/examples'
+          shell 'rm config/database.yml'
+          shell 'mv config/secrets.yml config/examples/secrets.yml'
+          copy_file_from_template('database.yml', 'config/examples/database.yml')
+
+          # Create Gemfile
+          copy_file_from_template('Gemfile')
+
+          # Init views
+          shell 'rm app/views/layouts/application.html.erb'
+          copy_file_from_template('views/application.slim', 'app/views/layouts/application.html.slim')
+        end
+    end
+  end
+end

data/lib/blueprint/generator/templates/rails_app/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{js,coffee}]
+indent_size = 4
+
+[*.{css,scss,less}]
+indent_size = 4

data/lib/blueprint/generator/templates/rails_app/.gitignore

@@ -0,0 +1,30 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore WebStorm IDE config.
+/.idea
+
+# And bundled gems.
+/vendor/bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+
+# Ignore configs which is different on different machines
+/config/database.yml
+/config/secrets.yml
+
+# Ignore code coverage by tests.
+/coverage
+
+# Ignore assets and uploads.
+/public/assets
+/public/system
+/public/uploads

data/lib/blueprint/generator/templates/rails_app/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/lib/blueprint/generator/templates/rails_app/Gemfile.erb

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.2.5.1'
+gem 'pg', '~> 0.15'
+
+gem 'slim-rails'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'jquery-rails'
+
+group :development, :test do
+  gem 'pry-byebug'
+end
+
+group :development do
+  gem 'web-console', '~> 2.0'
+  gem 'spring'
+end
+

data/lib/blueprint/generator/templates/rails_app/database.yml.erb

@@ -0,0 +1,16 @@
+default: &default
+  adapter: postgresql
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: <%= name%>_development
+
+test:
+  <<: *default
+  database: <%= name%>_test
+
+production:
+  <<: *default
+  database: <%= name%>_production

data/lib/blueprint/generator/templates/rails_app/views/application.slim.erb

@@ -0,0 +1,14 @@
+doctype html
+
+html
+  head
+    title <%= config[:title].empty? ? name : config[:title]%>
+
+    = stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true
+
+    = javascript_include_tag "application", "data-turbolinks-track" => true
+
+    = csrf_meta_tags
+  body
+
+    == yield

data/lib/blueprint/version.rb

@@ -0,0 +1,3 @@
+module Blueprint
+  VERSION = '0.2.0'.freeze
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: blueprint
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Datarockets
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate application with custom settings
+email:
+- hello@datarockets.com
+executables:
+- blueprint
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/blueprint
+- bin/console
+- bin/rspec
+- bin/setup
+- blueprint.gemspec
+- circle.yml
+- lib/blueprint.rb
+- lib/blueprint/cli.rb
+- lib/blueprint/generator/base.rb
+- lib/blueprint/generator/base/template_rendering.rb
+- lib/blueprint/generator/rails_app.rb
+- lib/blueprint/generator/templates/rails_app/.editorconfig
+- lib/blueprint/generator/templates/rails_app/.gitignore
+- lib/blueprint/generator/templates/rails_app/.ruby-version
+- lib/blueprint/generator/templates/rails_app/Gemfile.erb
+- lib/blueprint/generator/templates/rails_app/database.yml.erb
+- lib/blueprint/generator/templates/rails_app/views/application.slim.erb
+- lib/blueprint/version.rb
+homepage: https://github.com/datarockets/blueprint
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Rails application generator
+test_files: []