bretelline 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e04097487a7d9751b99b24fdb8e2e1fbd018c62
-  data.tar.gz: c4d186d68e9d226964d663989293e41d608e2b89
+  metadata.gz: b5c3567e21e47b2619058bf15be7a0157d92af22
+  data.tar.gz: 9888a831fd2c9840d1fbf177f405ddcd6f4f4547
 SHA512:
-  metadata.gz: e7b8aba7217f0a0ff5148d61d7b5f02d0b61ac74e3c1afa4d650b1a40e1e7300603fad5c37c659e7af0a077ca74aabbc83bcf881abcdce8f019e048f6b75449a
-  data.tar.gz: 0a3a6ce506e1fa18735ea76066334f40e154fc4a8a506619c2977339f058dfef1da395dd4d75742f1654191ad0b48d74f30c5b273a725ee3f8d7a1ef54fbc6bb
+  metadata.gz: b4ad960a20850e43e670f1959dca6df9ee674eda8d204c1c76a80a8c5de0087ba7897de07fa01cd1d3a5c37040856aafab0ebb2fd2f2ba9c0c19f0737c659428
+  data.tar.gz: dc29010e2a2e19109de9def1f2e03807daaddb57151e1f111d6e685ab6eda559fceb913ad2cace6c3227f48658f210bd324e0c6376fb9a3ddda7431ac7c4cd19

data/lib/bretelline/app_generator.rb

@@ -3,6 +3,9 @@ module Bretelline
     class_option :database, type: :string, aliases: "-d", default: "postgresql",
                             desc: "Configure for selected database (options: #{DATABASES.join('/')})"
 
+    class_option :skip_spring, type: :boolean, default: true,
+                               desc: "Don't install Spring application preloader"
+
     class_option :skip_test, type: :boolean, default: true,
                              desc: "Skip Test Unit"
 
@@ -34,7 +37,7 @@ module Bretelline
     def bretelline
       bundle_command 'install'
       invoke :create_database
-      build :install_engine
+      build :setup
       invoke :migrate_database
     end
 

data/lib/bretelline/builders/solidus.rb

@@ -5,15 +5,50 @@ module Bretelline
         template "solidus_gemfile.erb", "Gemfile"
       end
 
-      def install_engine
-        bundle_command "exec rails g spree:install"
-        bundle_command "exec rails g solidus:auth:install"
-        bundle_command "exec rake railties:install:migrations"
+      def setup
+        solidus
+        rspec
+        ci
+        rubocop
       end
 
       def readme
         template 'README.md.erb', 'README.md'
       end
+
+      private
+
+      def solidus
+        bundle_command "exec rails g spree:install --sample=false"
+        bundle_command "exec rails g solidus:auth:install"
+        bundle_command "exec rake railties:install:migrations"
+        empty_directory_with_keep_file 'app/overrides'
+      end
+
+      def rspec
+        bundle_command "exec rails generate rspec:install"
+        directory 'spec/support'
+        remove_file 'spec/rails_helper.rb'
+        copy_file 'spec/rails_helper.rb', 'spec/rails_helper.rb'
+        prepend_to_file 'spec/spec_helper.rb', "require 'support/simplecov'\n"
+        empty_directory_with_keep_file 'spec/features'
+        empty_directory_with_keep_file 'spec/models'
+        empty_directory_with_keep_file 'spec/controllers'
+        empty_directory_with_keep_file 'spec/jobs'
+        empty_directory_with_keep_file 'spec/pages/sections'
+        empty_directory_with_keep_file 'spec/factories'
+        remove_file 'bin/rails'
+        copy_file 'bin_rails', 'bin/rails'
+      end
+
+      def ci
+        copy_file 'circle.yml', 'circle.yml'
+      end
+
+      def rubocop
+        copy_file 'rubocop.yml', '.rubocop.yml'
+        bundle_command 'exec rubocop -a'
+      end
     end
   end
 end

data/lib/bretelline/templates/README.md.erb

@@ -1 +1,65 @@
 # <%= app_name.humanize %>
+
+This is [Solidus](https://solidus.io/) eCommerce application.
+
+## Development Setup
+
+1. Clone the repo:
+
+  ```
+  $ cd ~/Code
+  $ git clone git@github.com:nebulab/<%= app_name.humanize %>.git
+  $ cd <%= app_name.humanize %>
+  ```
+
+2. Install dependencies and prepare database:
+
+  ```
+  $ ./bin/setup
+  ```
+
+3. You're up and running. Just start foreman:
+
+  ```
+  $ bundle exec invoker start invoker.ini
+  ```
+
+Notes:
+
+* Make sure you have PostgreSQL and Redis up and running
+* Seeds include a user that developer can use locally to login:
+
+  ```
+  Email: admin@example.com
+  Psw:   test123
+  ```
+
+## <%= app_name.humanize %> basic development style guide
+
+1. *Always* create separate branches and pull requests for adding/removing/changing code;
+2. Write feature and unit specs as needed and respect project guidelines (code coverange, quality metrics, ...);
+3. Use imperative commit messages with capitalized first letter (eg. "Add this feature" instead
+of "adds this feature"). Use descriptive commits (with both title and description) and respect title length;
+4. If we are working on a new feature, it's better to create seed data for the models we are working on to
+let other devs reproduce behavior or eventual issues with these;
+5. When porting some code from Solidus please use a separate commit referring to the original code you're porting
+with a link to the Solidus GH project;
+6. Please refer to [GitHub Ruby Styleguide](https://github.com/styleguide/ruby) when writing Ruby code.
+
+## Running tests
+
+<%= app_name.humanize %> is covered with basic fuctional tests using Rspec, FactoryGirl and Capybara (the same tools used by Solidus).
+Javascript tests are run via Selenium ChromeDriver so you'll need to install _Chrome_ first (which is required).
+
+To run the test suite run:
+
+  ```
+  $ rake db:test:prepare
+  $ rspec spec
+  ```
+
+Please aim to full test coverage.
+
+## Deploying <%= app_name.humanize %>
+
+Deploys depend on the app's configuration and can change from app to app. When in doubt ask [mtylty](https://github.com/mtylty).

data/lib/bretelline/templates/bin_rails

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+if ENV['RAILS_ENV'] == 'test'
+  require 'simplecov'
+
+  # Save to CircleCI's artifacts directory if we're on CircleCI
+  if ENV['CIRCLE_ARTIFACTS']
+    dir = File.join(ENV['CIRCLE_ARTIFACTS'], "coverage")
+    SimpleCov.coverage_dir(dir)
+  end
+
+  SimpleCov.start 'rails' do
+    add_filter 'config/application'
+  end
+end
+
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/lib/bretelline/templates/circle.yml

@@ -0,0 +1,10 @@
+machine:
+  services:
+    - redis
+test:
+  pre:
+    - mkdir $CIRCLE_ARTIFACTS/coverage $CIRCLE_ARTIFACTS/quality $CIRCLE_ARTIFACTS/security
+    - curl -s https://raw.githubusercontent.com/chronogolf/circleci-google-chrome/master/use_chrome_stable_version.sh | bash
+  post:
+    - bundle exec rubocop --format html -o $CIRCLE_ARTIFACTS/quality/rubocop.html
+    - bundle exec brakeman --exit-on-warn --confidence-level 2 -o $CIRCLE_ARTIFACTS/security/brakeman.html

data/lib/bretelline/templates/rubocop.yml

@@ -0,0 +1,177 @@
+# Custom rules
+AllCops:
+  Include:
+    - Rakefile
+    - config.ru
+  Exclude:
+    - db/schema.rb
+    - db/migrate/*
+    - tmp/**/*
+    - vendor/**/*
+    - bin/**/*
+    - log/**/*
+
+Rails:
+  Enabled: true
+
+# Relaxed.Ruby.Style
+## Version 2.1
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Style/DotPosition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutdotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+Style/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutspaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainarguments
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainliteral
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/lib/bretelline/templates/solidus_gemfile.erb

@@ -37,9 +37,8 @@ gem 'seedbank', '~> 0.4'
 
 group :development, :test do
   gem 'dev_tools', github: 'nebulab/dev_tools'
+  gem 'listen', '~> 3.0.5'
   gem 'rspec-rails', '~> 3.6.0'
-  gem 'spring'
-  gem 'spring-watcher-listen', '~> 2.0.0'
   gem 'web-console', '>= 3.3.0'
 end
 

data/lib/bretelline/templates/spec/rails_helper.rb

@@ -0,0 +1,61 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'spec_helper'
+require 'rspec/rails'
+require 'ffaker'
+
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# We manually require each file to make sure the files are required in the
+# correct order and no exceptions come up because of wrong require order
+%w(
+  spec/support/capybara
+  spec/support/database_cleaner
+  spec/support/solidus
+  spec/support/tools
+  spec/support/paperclip
+).each { |path| require Rails.root.join(path) }
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+# Checks for pending migration and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

data/lib/bretelline/templates/spec/support/capybara.rb

@@ -0,0 +1,6 @@
+Capybara.register_driver :selenium do |app|
+  Capybara::Selenium::Driver.new(app, browser: :chrome)
+end
+
+# Wait some seconds after clicks
+Capybara.default_max_wait_time = 5

data/lib/bretelline/templates/spec/support/database_cleaner.rb

@@ -0,0 +1,44 @@
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+
+  config.before(:suite) do
+    if config.use_transactional_fixtures?
+      raise(<<-MSG)
+        Delete line `config.use_transactional_fixtures = true` from rails_helper.rb
+        (or set it to false) to prevent uncommitted transactions being used in
+        JavaScript-dependent specs.
+
+        During testing, the app-under-test that the browser driver connects to
+        uses a different database connection to the database connection used by
+        the spec. The app's database connection would not be able to access
+        uncommitted transaction data setup over the spec's database connection.
+      MSG
+    end
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, type: :feature) do
+    # :rack_test driver's Rack app under test shares database connection
+    # with the specs, so continue to use transaction strategy for speed.
+    driver_shares_db_connection_with_specs = Capybara.current_driver == :rack_test
+
+    if !driver_shares_db_connection_with_specs
+      # Driver is probably for an external browser with an app
+      # under test that does *not* share a database connection with the
+      # specs, so use truncation strategy.
+      DatabaseCleaner.strategy = :truncation
+    end
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.append_after(:each) do
+    DatabaseCleaner.clean
+  end
+end