rails-embryo 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3f4ad3fec63bed5cd7163c4e0324cdf91ff68a5
+  data.tar.gz: f84aec31ccfaa312d3e3a11224770863e757c9dc
+SHA512:
+  metadata.gz: e035eb9df84d3977804a7a9bacc5263bd4978bc234c0b87678a2ff80930332104adb5ef3e0497f7f3317200885637c4092d7df22e4e5c55f20bbb511f46e0768
+  data.tar.gz: 10e4aa4adef14787d8c83983e84c1b0b177fac2bc9167a836ffed6c721859e713e925ff2338ab894ad80179bb8b0075f04ba4ac8925a2c336f3831a7f0bd40d7

data/History.md

@@ -1,3 +1,10 @@
+### Version 0.3.0
+2014-09-14
+
+* Remove standalone executable in favor of running the 'embryo' generator
+* Configure Postgres automatically
+* Generate a working JavaScript-enabled spec
+
 ### Version 0.2.1
 2014-08-05
 

data/README.md

@@ -15,52 +15,43 @@ configurable in the future.
 ### Requirements
 
 * Ruby 1.9.3 or newer
-* Rails 4.1.4 or newer
+* Rails 4.1.6 or newer
 
-### Generating a New Application
+### Getting Started
 
-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).
+The rails-embryo gem provides an `embryo` generator that is designed to enhance a
+newly-generated Rails application. This guide assumes you've created a new Rails application
+using the `rails new` command, and that you've changed into the application directory.
 
-    gem install rails-embryo
+Add "rails-embryo" to the new application's Gemfile and install it via Bundler:
 
-Once rails-embryo is installed, you can run "rails-embryo new" the
-same way you would normally run "rails new".
+    echo "gem 'rails-embryo'" >> Gemfile
+    bundle install
 
-    rails-embryo new my_project
+Now you're ready to generate the rails-embryo enhancements. It's recommended to provide the
+`--force` option to the generator, since some of the files from your newly-generated Rails
+application will need to be overwritten.
 
-This will create a new application called "My Project" in a directory
-called my_project. It's the same skeleton Rails app you would get from
-"rails new", but with additional rails-embryo-specific enhancements
-(described below).
+    rails generate embryo --force
 
-The enhancements include .ruby-version and .ruby-gemset files, so if
-your system is configured with a Ruby version manager that looks for
-those files, you should be able to change into the project directory
-and then run Bundler to configure the gems for your new application.
+To verify that the rails-embryo enhancements have been installed, you'll need to update your
+installed Gems again, and then initialize the database. You may want to look at the generated
+`config/database.yml`, which assumes a local Postgres server is available, and make any
+necessary changes to that file first.
 
-    cd my_project
     bundle install
+    rake db:create
 
-Your new application will have a working test suite, and you can run
-it by invoking RSpec (or Rake, but RSpec is faster).
+Now you can run the generated RSpec suite by invoking RSpec (or Rake, but RSpec is faster).
 
     rspec
 
-It's also ready to run with the Rails server, so fire up the server
-and visit localhost:3000 to see your application's
-Bootstrap-enhanced landing page.
+You can also see your application's new Bootstrap-enhanced landing page by running a
+development server and visiting `http://localhost:3000/`.
 
     rails server
 
-### Generators Available in the Application
-
-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
+### Other Generators
 
 Once Rails Embryo has has been initialized in an application, more
 generators are available to add features to the app.
@@ -133,15 +124,22 @@ feature "Customer searches for widgets" do
 
 #### Other Enhancements
 
-A .ruby-version file is created that specifies Ruby 2.1.2, and a
-.ruby-gemset file is created with a gemset that has the same name as
-your application directory. These can be safely ignored on systems
-that aren't automatically configured to switch Ruby versions and/or
-gemsets based on these files.
-
 Some files that normally have lots of documentation comments added
 when they are first generated (e.g. Gemfile, routes.rb, and others)
 will have all comments removed by rails-futurizer. These comments may
 be helpful for new users, but they may be more of a distraction for
 experienced developers, and they tend to get out of date as Rails and
 other gems are updated.
+
+#### For Existing Rails Applications
+
+You can attempt to run the `embryo` generator on an existing application that has been
+modified since it was first generated, but rails-embryo makes little attempt to coexist with
+those modifications, so you may get undesirable results.
+
+#### Using With Ruby Version Managers (rvm, rbenv, etc.)
+
+The `embryo` generator does not create configuration for any Ruby version manager you might be
+using. If you're using a Ruby version manager, configure your Ruby version and gemset as
+desired for your application as a part of generating the application before running the
+`embryo` generator.

data/bin/rails-embryo

@@ -1,34 +1,11 @@
 #!/usr/bin/env ruby
-require "rake"
-
-task "embryo_new", :path do |task, args|
-  verbose false
-  path = args[:path]
-  if File.exists?(path) && (Dir.entries(path) - [".", ".."]).any?
-    puts "Rerunning Rails app generator in existing application..."
-    sh "rails new #{path} --skip-bundle"
-    puts "Reapplying Embryo extensions to existing application..."
-    sh "cd #{path}; rails g embryo"
-  else
-    puts "Generating standard Rails application..."
-    sh "rails new #{path} --skip-bundle"
-    puts "Adding Embryo extensions to generated application..."
-    sh "cd #{path}; rails g embryo --force"
-  end
-end
-
-if ARGV[0] == "new"
-  if ARGV[1]
-    Rake.application["embryo_new"].invoke ARGV[1]
-  else
-    puts 'Missing required argument ("rails-embryo help" for info)'
-  end
-else
-  puts 'Usage: rails-embryo COMMAND [ARGS]
-
-Available commands:
-  help      Show this message
-  new PATH  Create a new Rails application in PATH with rails-embryo
-            enhancements. "rails-embryo new my_app" creates a new
-            application called MyApp in "./my_app"'
-end
+puts
+puts "    NOTICE:"
+puts
+puts "    The rails-embryo command is no longer used to initialize"
+puts "    new applications."
+puts
+puts "    Instead, install the 'rails-embryo' gem in an existing"
+puts "    application (or one freshly created with 'rails-new'),"
+puts "    and then run 'rails generate embryo'."
+puts

data/lib/generators/embryo.rb

@@ -1,5 +1,4 @@
 require "rails/generators"
-require "generators/embryo/ruby_version"
 require "generators/embryo/default_view"
 require "generators/embryo/template_support"
 require "generators/embryo/rspec"
@@ -7,11 +6,11 @@ require "generators/embryo/factory_girl"
 require "generators/embryo/capybara"
 require "generators/embryo/poltergeist"
 require "generators/embryo/devise"
+require "generators/embryo/application"
+require "generators/embryo/postgres"
 
 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"
@@ -19,6 +18,8 @@ class EmbryoGenerator < Rails::Generators::Base
     invoke "embryo:template_support"
     invoke "embryo:default_view"
     invoke "embryo:devise"
+    invoke "embryo:application"
+    invoke "embryo:postgres"
     clean_files
   end
 
@@ -29,8 +30,4 @@ class EmbryoGenerator < Rails::Generators::Base
     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/application.rb

@@ -0,0 +1,31 @@
+require "rails-embryo"
+require "securerandom"
+
+module Embryo
+  class ApplicationGenerator < Rails::Generators::Base
+    include GeneratorHelpers::Hidden
+    include GeneratorHelpers::Files
+
+    def install
+      create_file "config/secrets.yml", secrets_yml_data
+      create_file "config/secrets.yml.example", secrets_yml_data
+      gitignore "config/secrets.yml"
+      duplicate_file "config/environments/staging.rb", "config/environments/production.rb"
+    end
+
+    private
+
+    def secrets_yml_data
+@secrets_yml_data ||= "development:
+  secret_key_base: #{new_secret}
+
+test:
+  secret_key_base: #{new_secret}
+"
+    end
+
+    def new_secret
+      SecureRandom.hex 64
+    end
+  end
+end

data/lib/generators/embryo/default_view.rb

@@ -48,7 +48,7 @@ end
 'require "rails_helper.rb"
 
 feature "Dashboard" do
-  scenario "index view" do
+  scenario "index view", :js do
     visit "/"
     expect(page).to have_content "Welcome"
   end

data/lib/generators/embryo/poltergeist.rb

@@ -6,7 +6,9 @@ module Embryo
 
     def install
       gem "poltergeist", "~> 1.0", group: :test
+      gem "database_cleaner", group: :test
       create_file "spec/support/poltergeist.rb", poltergeist_helper_data
+      create_file "spec/support/database_cleaner.rb", cleaner_helper_data
     end
 
     private
@@ -14,6 +16,28 @@ module Embryo
     def poltergeist_helper_data
 'require "capybara/poltergeist"
 Capybara.javascript_driver = :poltergeist
+'
+    end
+
+    def cleaner_helper_data
+'require "database_cleaner"
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+
+  config.before :suite do
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before :example do |example|
+    DatabaseCleaner.strategy = example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner.start
+  end
+
+  config.after :example do
+    DatabaseCleaner.clean
+  end
+end
 '
     end
   end

data/lib/generators/embryo/postgres.rb

@@ -0,0 +1,32 @@
+require "rails-embryo"
+
+module Embryo
+  class PostgresGenerator < Rails::Generators::Base
+    include GeneratorHelpers::Hidden
+    include GeneratorHelpers::Files
+
+    def install
+      gem "pg"
+      create_file "config/database.yml", database_yml_data
+      create_file "config/database.yml.example", database_yml_data
+      gitignore "config/database.yml"
+    end
+
+    private
+
+    def database_yml_data
+"default: &default
+  adapter: postgresql
+  template: template0
+
+test:
+  <<: *default
+  database: #{application_name}_test
+
+development:
+  <<: *default
+  database: #{application_name}_development
+"
+    end
+  end
+end

data/lib/generators/embryo/rspec.rb

@@ -34,7 +34,6 @@ Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
 ActiveRecord::Migration.maintain_test_schema!
 
 RSpec.configure do |config|
-  config.use_transactional_fixtures = true
   config.infer_spec_type_from_file_location!
 end
 '

data/lib/rails-embryo.rb

@@ -1,5 +1,6 @@
 require "rails-embryo/version"
 require "rails-embryo/generator_helpers/hidden"
+require "rails-embryo/generator_helpers/files"
 require "generators/embryo"
 require "generators/embryo/model"
 require "generators/embryo/model/authenticated"

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

@@ -0,0 +1,25 @@
+module Embryo
+  module GeneratorHelpers
+    module Files
+      def duplicate_file(source, destination)
+        create_file source, File.read(destination) if File.exist? destination
+      end
+
+      def append_file(path, *args)
+        File.exist?(path) ? super : create_file(path, *args)
+      end
+
+      def gitignore(path)
+        append_file ".gitignore", "/#{path}\n"
+      end
+
+      def application_name
+        if Rails.respond_to? :application
+          Rails.application.class.parent_name.underscore
+        else
+          "unknown"
+        end
+      end
+    end
+  end
+end

data/lib/rails-embryo/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Embryo
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,52 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: rails-embryo
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Brian Auton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-09-14 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.4
+        version: 4.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.4
+        version: 4.1.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -67,47 +60,48 @@ 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/model/authenticated.rb
-- lib/generators/embryo/factory_girl.rb
+- History.md
+- License.txt
+- README.md
+- bin/rails-embryo
+- lib/generators/embryo.rb
+- lib/generators/embryo/application.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/devise.rb
+- lib/generators/embryo/factory_girl.rb
+- lib/generators/embryo/model.rb
+- lib/generators/embryo/model/authenticated.rb
 - lib/generators/embryo/poltergeist.rb
+- lib/generators/embryo/postgres.rb
 - lib/generators/embryo/rspec.rb
-- lib/generators/embryo/ruby_version.rb
-- lib/generators/embryo.rb
-- README.md
-- History.md
-- License.txt
-- bin/rails-embryo
+- lib/generators/embryo/template_support.rb
+- lib/rails-embryo.rb
+- lib/rails-embryo/generator_helpers/files.rb
+- lib/rails-embryo/generator_helpers/hidden.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: 1.8.29
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generators for quick setup of advanced Rails practices
 test_files: []

data/lib/generators/embryo/ruby_version.rb

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