rails-embryo 0.1.1 → 0.2.0

data/History.md

@@ -1,3 +1,9 @@
+### Version 0.2.0
+2014-08-04
+
+* Add model generator
+* Minor fixes for basic app configuration
+
 ### Version 0.1.1
 2014-6-10
 

data/README.md

@@ -2,7 +2,6 @@
 [![Gem Version](https://badge.fury.io/rb/rails-embryo.png)](http://badge.fury.io/rb/rails-embryo)
 [![Build Status](https://travis-ci.org/brianauton/rails-embryo.png?branch=master)](https://travis-ci.org/brianauton/rails-embryo)
 [![Code Climate](https://codeclimate.com/github/brianauton/rails-embryo.png)](https://codeclimate.com/github/brianauton/rails-embryo)
-[![Dependency Status](https://gemnasium.com/brianauton/rails-embryo.png)](https://gemnasium.com/brianauton/rails-embryo)
 
 Rails-embryo is a Ruby gem that helps get a new Rails application up and
 running quickly. In just one step, it adds many of the the tweaks and
@@ -16,12 +15,14 @@ configurable in the future.
 ### Requirements
 
 * Ruby 1.9.3 or newer
-* Rails 4.1.1 or newer
+* Rails 4.1.4 or newer
 
-### Getting Started
+### Generating a New Application
 
-Make sure the gem is installed in your current environment (this will
-also install Rails 4.1.1 if it's not already present).
+To generate a new Rails application with all Rails Embryo features
+added, first make sure the gem is installed in your current
+environment (this will also install Rails 4.1.4 if it's not already
+present).
 
     gem install rails-embryo
 
@@ -54,16 +55,33 @@ Bootstrap-enhanced landing page.
 
     rails server
 
-### Running the Generators Directly
+### Generators Available in the Application
 
-You can also install the rails-embryo enhancements by adding the gem
+You can also install the Rails Embryo enhancements by adding the gem
 to an existing Rails application and running the "embryo" generator:
 
     rails generate embryo
 
+Once Rails Embryo has has been initialized in an application, more
+generators are available to add features to the app.
+
+#### Models
+
+To generate a new model, run the `embryo:model` generator with the
+same arguments you would pass to Rails' basic `model` generator.
+
+    rails generate embryo:model user name email age:integer
+
+A class, migration, spec and factory will all be generated for the
+model. All options available for the [basic model
+generator](http://railsguides.net/advanced-rails-model-generators/)
+are accepted.
+
 ### Enhancements Added
 
-All of the following enhancements are added by rails-embryo.
+All of the following enhancements are added to new applications by
+rails-embryo, and are used whenever possible by the other "embryo"
+generators.
 
 #### Views and Templating
 
@@ -91,8 +109,15 @@ For acceptance testing,
 [Capybara](https://github.com/jnicklas/capybara) is installed, along
 with a simple end-to-end spec that uses it to test the `Welcome#index`
 action. [Poltergeist](https://github.com/teampoltergeist/poltergeist)
-is configured and ready for JavaScript-enabled testing; just add `js:
-true` to any RSpec `scenario` blocks that require JavaScript.
+is configured and ready for JavaScript-enabled testing; just add a `:js`
+metadata tag to any RSpec `feature` or `scenario` blocks that require
+JavaScript:
+
+```ruby
+feature "Customer searches for widgets" do
+  scenario "using the auto-suggest search box", :js do
+    # ...
+```
 
 #### Other Enhancements
 

data/lib/generators/embryo.rb

@@ -0,0 +1,34 @@
+require "rails/generators"
+require "generators/embryo/ruby_version"
+require "generators/embryo/default_view"
+require "generators/embryo/template_support"
+require "generators/embryo/rspec"
+require "generators/embryo/factory_girl"
+require "generators/embryo/capybara"
+require "generators/embryo/poltergeist"
+
+class EmbryoGenerator < Rails::Generators::Base
+  def install(force: false, bundle: false)
+    add_embryo_gem
+    invoke "embryo:ruby_version"
+    invoke "embryo:rspec"
+    invoke "embryo:factory_girl"
+    invoke "embryo:capybara"
+    invoke "embryo:poltergeist"
+    invoke "embryo:template_support"
+    invoke "embryo:default_view"
+    clean_files
+  end
+
+  private
+
+  def clean_files
+    gsub_file "Gemfile", /^#.*$/, "", verbose: false
+    gsub_file "Gemfile", /\n\n+/, "\n", verbose: false
+    append_to_file "Gemfile", "\n\n"
+  end
+
+  def add_embryo_gem
+    gem "rails-embryo", "~> #{Rails::Embryo::VERSION}", group: :development
+  end
+end

data/lib/generators/embryo/capybara.rb

@@ -0,0 +1,24 @@
+require "rails-embryo"
+
+module Embryo
+  class CapybaraGenerator < Rails::Generators::Base
+    include GeneratorHelpers::Hidden
+
+    def install
+      gem "capybara", "~> 2.0", group: :test
+      gem "launchy", "~> 2.0", group: :test
+      create_file "spec/support/capybara.rb", capybara_helper_data
+    end
+
+    private
+
+    def capybara_helper_data
+'require "capybara/rails"
+require "capybara/rspec"
+RSpec.configure do |config|
+  config.include Capybara::DSL, type: :feature
+end
+'
+    end
+  end
+end

data/lib/{embryo → generators/embryo}/default_view.rb

@@ -1,14 +1,15 @@
+require "rails-embryo"
+require "rails/generators"
+
 module Embryo
-  class DefaultView
-    def initialize(filesystem)
-      @filesystem = filesystem
-    end
+  class DefaultViewGenerator < Rails::Generators::Base
+    include GeneratorHelpers::Hidden
 
     def install
-      @filesystem.write "config/routes.rb", routes_data
-      @filesystem.write "app/controllers/dashboard_controller.rb", controller_data
-      @filesystem.write "spec/controllers/dashboard_controller_spec.rb", controller_spec_data
-      @filesystem.write "spec/features/dashboard_spec.rb", feature_spec_data
+      create_file "config/routes.rb", routes_data
+      create_file "app/controllers/dashboard_controller.rb", controller_data
+      create_file "spec/controllers/dashboard_controller_spec.rb", controller_spec_data
+      create_file "spec/features/dashboard_spec.rb", feature_spec_data
     end
 
     private

data/lib/generators/embryo/factory_girl.rb

@@ -0,0 +1,21 @@
+require "rails-embryo"
+
+module Embryo
+  class FactoryGirlGenerator < Rails::Generators::Base
+    include GeneratorHelpers::Hidden
+
+    def install
+      gem "factory_girl_rails", "~> 4.0", group: :test
+      create_file "spec/support/factory_girl.rb", factory_girl_helper_data
+    end
+
+    private
+
+    def factory_girl_helper_data
+'RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end
+'
+    end
+  end
+end

data/lib/generators/embryo/model.rb

@@ -0,0 +1,37 @@
+require "rails/generators"
+
+module Embryo
+  class ModelGenerator < Rails::Generators::NamedBase
+    def install
+      generate "rails:model", "#{ARGV.join ' '} --no-test-framework"
+      create_file "spec/factories/#{file_path}.rb", factory_data
+      create_file "spec/models/#{file_path}_spec.rb", spec_data
+    end
+
+    private
+
+    def factory_data
+class_option = class_path.any? ? ", class: #{class_name}" : ""
+'FactoryGirl.define do
+  factory :' + factory_name + class_option + ' do
+  end
+end
+'
+    end
+
+    def spec_data
+'require "rails_helper"
+
+describe ' + class_name + ' do
+  it "initializes successfully" do
+    expect(build :' + factory_name + ').to be_valid
+  end
+end
+'
+    end
+
+    def factory_name
+      file_path.gsub "/", "_"
+    end
+  end
+end

data/lib/generators/embryo/poltergeist.rb

@@ -0,0 +1,20 @@
+require "rails-embryo"
+
+module Embryo
+  class PoltergeistGenerator < Rails::Generators::Base
+    include GeneratorHelpers::Hidden
+
+    def install
+      gem "poltergeist", "~> 1.0", group: :test
+      create_file "spec/support/poltergeist.rb", poltergeist_helper_data
+    end
+
+    private
+
+    def poltergeist_helper_data
+'require "capybara/poltergeist"
+Capybara.javascript_driver = :poltergeist
+'
+    end
+  end
+end

data/lib/{embryo → generators/embryo}/rspec.rb

@@ -1,15 +1,18 @@
+require "rails-embryo"
+
 module Embryo
-  class Rspec
-    def initialize(filesystem)
-      @filesystem = filesystem
-    end
+  class RspecGenerator < Rails::Generators::Base
+    include GeneratorHelpers::Hidden
 
     def install
-      @filesystem.require_gem "rspec-rails", "~> 3.0", group: :test
-      @filesystem.write "spec/spec_helper.rb", spec_helper_data
-      @filesystem.write "spec/rails_helper.rb", rails_helper_data
+      gem "rspec-rails", "~> 3.0", group: :test
+      create_file "spec/spec_helper.rb", spec_helper_data
+      create_file "spec/rails_helper.rb", rails_helper_data
+      remove_dir "test"
     end
 
+    private
+
     def spec_helper_data
 'RSpec.configure do |config|
   config.color = true

data/lib/generators/embryo/ruby_version.rb

@@ -0,0 +1,12 @@
+require "rails-embryo"
+
+module Embryo
+  class RubyVersionGenerator < Rails::Generators::Base
+    include GeneratorHelpers::Hidden
+
+    def install
+      create_file ".ruby-version", "2.1.2\n"
+      create_file ".ruby-gemset", "#{File.basename Dir.getwd}\n"
+    end
+  end
+end

data/lib/{embryo → generators/embryo}/template_support.rb

@@ -1,21 +1,23 @@
+require "rails-embryo"
+
 module Embryo
-  class TemplateSupport
-    def initialize(filesystem)
-      @filesystem = filesystem
-    end
+  class TemplateSupportGenerator < Rails::Generators::Base
+    include GeneratorHelpers::Hidden
 
     def install
-      @filesystem.require_gem "haml", "~> 4.0"
-      @filesystem.require_gem "haml-rails", ">= 0"
-      @filesystem.require_gem "bootstrap-sass", "~> 3.0"
-      @filesystem.write "app/views/layouts/application.html.haml", layout_data
-      @filesystem.write "app/views/layouts/_navigation.html.haml", navigation_data
-      @filesystem.write "app/views/layouts/_messages.html.haml", messages_data
-      @filesystem.write "app/assets/javascripts/application.js", javascript_data
-      @filesystem.write "app/assets/stylesheets/bootstrap-custom.css.scss", stylesheet_data
-      @filesystem.delete "app/views/layouts/application.html.erb"
+      gem "haml", "~> 4.0"
+      gem "haml-rails", ">= 0"
+      gem "bootstrap-sass", "~> 3.0"
+      create_file "app/views/layouts/application.html.haml", layout_data
+      create_file "app/views/layouts/_navigation.html.haml", navigation_data
+      create_file "app/views/layouts/_messages.html.haml", messages_data
+      create_file "app/assets/javascripts/application.js", javascript_data
+      create_file "app/assets/stylesheets/bootstrap-custom.css.scss", stylesheet_data
+      remove_file "app/views/layouts/application.html.erb"
     end
 
+    private
+
     def layout_data
 '!!! 5
 %html(lang="en")
@@ -23,7 +25,7 @@ module Embryo
     %meta(charset="utf-8")
     %meta(http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1")
     %meta(name="viewport" content="width=device-width, initial-scale=1.0")
-    %title ' + @filesystem.application_human_name + '
+    %title ' + application_human_name + '
     = stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true
     = javascript_include_tag "application", "data_turbolinks_track" => true
     = csrf_meta_tags
@@ -44,7 +46,7 @@ module Embryo
         %span.icon-bar
         %span.icon-bar
         %span.icon-bar
-      = link_to "' + @filesystem.application_human_name + '", root_path, class: "navbar-brand"
+      = link_to "' + application_human_name + '", root_path, class: "navbar-brand"
     .navbar-collapse.collapse
       %ul.nav.navbar-nav
         %li= link_to "Home", root_path
@@ -75,5 +77,9 @@ module Embryo
 body { padding-top: 70px; }
 '
     end
+
+    def application_human_name
+      File.basename(Dir.getwd).titleize
+    end
   end
 end

data/lib/rails-embryo.rb

@@ -1,50 +1,11 @@
-require "rails/generators"
-require "rails/generators/app_base"
 require "rails-embryo/version"
-require "embryo/filesystem"
-require "embryo/ruby_version"
-require "embryo/test_support"
-require "embryo/template_support"
-require "embryo/default_view"
-
-class EmbryoGenerator < Rails::Generators::Base
-  def install(force: false, bundle: false)
-    @force = force || options.force?
-    clean_files
-    add_embryo_gem
-    Embryo::RubyVersion.new(filesystem).install
-    Embryo::TestSupport.new(filesystem).install
-    Embryo::TemplateSupport.new(filesystem).install
-    Embryo::DefaultView.new(filesystem).install
-    filesystem.commit_changes
-    update_bundle if bundle
-  end
-
-  private
-
-  def clean_files
-    gemfile.remove_noise
-  end
-
-  def add_embryo_gem
-    filesystem.require_gem "rails-embryo", "~> #{Rails::Embryo::VERSION}"
-  end
-
-  def filesystem
-    @filesystem ||= Embryo::Filesystem.new self, force: @force
-  end
-
-  def gemfile
-    filesystem.gemfile
-  end
-
-  def update_bundle
-    command = "bundle install"
-    if `which bundle`.strip.present?
-      say_status :run, command
-      `#{command}`
-    else
-      say_status :skip, command, :yellow
-    end
+require "rails-embryo/generator_helpers/hidden"
+require "generators/embryo"
+require "generators/embryo/model"
+require "rails/railtie"
+
+class EmbryoHiddenGeneratorsRailtie < Rails::Railtie
+  config.app_generators do |generators|
+    generators.hidden_namespaces.concat Embryo::GeneratorHelpers::Hidden.namespaces
   end
 end

data/lib/rails-embryo/generator_helpers/hidden.rb

@@ -0,0 +1,13 @@
+module Embryo
+  module GeneratorHelpers
+    module Hidden
+      def self.namespaces
+        @namespaces ||= []
+      end
+
+      def self.included(generator)
+        namespaces << generator.namespace
+      end
+    end
+  end
+end

data/lib/rails-embryo/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Embryo
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,32 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: rails-embryo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Brian Auton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 4.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 4.1.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -60,44 +67,45 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/rails-embryo/generator_helpers/hidden.rb
+- lib/rails-embryo/version.rb
+- lib/rails-embryo.rb
+- lib/generators/embryo/factory_girl.rb
+- lib/generators/embryo/capybara.rb
+- lib/generators/embryo/default_view.rb
+- lib/generators/embryo/model.rb
+- lib/generators/embryo/template_support.rb
+- lib/generators/embryo/poltergeist.rb
+- lib/generators/embryo/rspec.rb
+- lib/generators/embryo/ruby_version.rb
+- lib/generators/embryo.rb
+- README.md
 - History.md
 - License.txt
-- README.md
 - bin/rails-embryo
-- lib/embryo/capybara.rb
-- lib/embryo/default_view.rb
-- lib/embryo/factory_girl.rb
-- lib/embryo/filesystem.rb
-- lib/embryo/gemfile.rb
-- lib/embryo/poltergeist.rb
-- lib/embryo/rspec.rb
-- lib/embryo/ruby_version.rb
-- lib/embryo/template_support.rb
-- lib/embryo/test_support.rb
-- lib/rails-embryo.rb
-- lib/rails-embryo/version.rb
 homepage: http://github.com/brianauton/rails-embryo
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.29
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Generators for quick setup of advanced Rails practices
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: e320f4f9a4efed26ee96d1734d44a7487075b7ca
-  data.tar.gz: 1d459d50c459dbfa6b33d15b0fae53bd23e4fd8b
-SHA512:
-  metadata.gz: c17ec6e686cbd30e3c0005d7ffd5b426cfe44e17d30abe6cf8afb0b84bb0296e2ac644cc371668dee1b83ec4f6dab74daaf5b92ab237511935875b3e53d169a1
-  data.tar.gz: 23ef35d270cf9d87197c9333fb224b7fd6b9a17fa84e3151a1ef7f803d68c27330ea6233556970adf8ad07a9567b8741d444f9efb47f7f540128ee87bb4bb964

data/lib/embryo/capybara.rb

@@ -1,22 +0,0 @@
-module Embryo
-  class Capybara
-    def initialize(filesystem)
-      @filesystem = filesystem
-    end
-
-    def install
-      @filesystem.require_gem "capybara", "~> 2.0", group: :test
-      @filesystem.require_gem "launchy", "~> 2.0", group: :test
-      @filesystem.write "spec/support/capybara.rb", capybara_helper_data
-    end
-
-    def capybara_helper_data
-'require "capybara/rails"
-require "capybara/rspec"
-RSpec.configure do |config|
-  config.include Capybara::DSL, type: :feature
-end
-'
-    end
-  end
-end

data/lib/embryo/factory_girl.rb

@@ -1,19 +0,0 @@
-module Embryo
-  class FactoryGirl
-    def initialize(filesystem)
-      @filesystem = filesystem
-    end
-
-    def install
-      @filesystem.require_gem "factory_girl_rails", "~> 4.0", group: :test
-      @filesystem.write "spec/support/factory_girl.rb", factory_girl_helper_data
-    end
-
-    def factory_girl_helper_data
-'RSpec.configure do |config|
-  config.include FactoryGirl::Syntax::Methods
-end
-'
-    end
-  end
-end

data/lib/embryo/filesystem.rb

@@ -1,53 +0,0 @@
-require "embryo/gemfile"
-require "tmpdir"
-require "active_support/inflector"
-
-module Embryo
-  class Filesystem
-    def initialize(generator, *write_options)
-      @generator = generator
-      @write_options = write_options
-      @write_cache = {}
-      @gemfile = nil
-    end
-
-    def commit_changes
-      @gemfile.write(*@write_options) if @gemfile
-      sorted_cache.each do |path, data|
-        if data
-          @generator.create_file path, data, *@write_options
-        else
-          @generator.remove_file path, *@write_options if File.exist? path
-        end
-      end
-    end
-
-    def sorted_cache
-      @write_cache.sort.to_h
-    end
-
-    def require_gem(*args)
-      gemfile.require_gem(*args)
-    end
-
-    def gemfile
-      @gemfile ||= Gemfile.current generator: @generator
-    end
-
-    def write(path, data)
-      @write_cache[path] = data
-    end
-
-    def delete(path)
-      @write_cache[path] = nil
-    end
-
-    def application_name
-      File.basename Dir.getwd
-    end
-
-    def application_human_name
-      application_name.titleize
-    end
-  end
-end

data/lib/embryo/gemfile.rb

@@ -1,39 +0,0 @@
-module Embryo
-  class Gemfile
-    attr_accessor :path, :data
-
-    def initialize(path, generator: nil)
-      @path = path
-      @generator = generator
-      @data = File.exist?(path) ? File.read(path) : ""
-    end
-
-    def remove_noise
-      @data = @data.each_line.select { |line| line[0] != "#" }.join
-      @data.gsub!(/\n\n+/, "\n\n")
-      @data.gsub!(/\n+$/, "\n")
-    end
-
-    def require_gem(name, version, options = {})
-      remove_gem name
-      @data << "\n" unless @data[-1] == "\n"
-      @data << "gem '#{name}', '#{version}'"
-      options.each { |key, value| @data << ", #{key}: #{value.inspect}" }
-      @data << "\n"
-    end
-
-    def remove_gem(name)
-      @data = @data.each_line.reject do |line|
-        line.match(/ *gem +'#{name}'/) or line.match(/ *gem +"#{name}"/)
-      end.join
-    end
-
-    def write(force: false)
-      @generator.create_file path, data, force: force
-    end
-
-    def self.current(generator: nil)
-      new "Gemfile", generator: generator
-    end
-  end
-end

data/lib/embryo/poltergeist.rb

@@ -1,18 +0,0 @@
-module Embryo
-  class Poltergeist
-    def initialize(filesystem)
-      @filesystem = filesystem
-    end
-
-    def install
-      @filesystem.require_gem "poltergeist", "~> 1.0", group: :test
-      @filesystem.write "spec/support/poltergeist.rb", poltergeist_helper_data
-    end
-
-    def poltergeist_helper_data
-'require "capybara/poltergeist"
-Capybara.javascript_driver = :poltergeist
-'
-    end
-  end
-end

data/lib/embryo/ruby_version.rb

@@ -1,12 +0,0 @@
-module Embryo
-  class RubyVersion
-    def initialize(filesystem)
-      @filesystem = filesystem
-    end
-
-    def install
-      @filesystem.write ".ruby-version", "2.1.2\n"
-      @filesystem.write ".ruby-gemset", "#{@filesystem.application_name}\n"
-    end
-  end
-end

data/lib/embryo/test_support.rb

@@ -1,19 +0,0 @@
-require "embryo/rspec"
-require "embryo/factory_girl"
-require "embryo/capybara"
-require "embryo/poltergeist"
-
-module Embryo
-  class TestSupport
-    def initialize(filesystem)
-      @filesystem = filesystem
-    end
-
-    def install
-      Rspec.new(@filesystem).install
-      FactoryGirl.new(@filesystem).install
-      Capybara.new(@filesystem).install
-      Poltergeist.new(@filesystem).install
-    end
-  end
-end