katapult 0.1.0

data/katapult.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'katapult/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'katapult'
+  spec.version       = Katapult::VERSION
+  spec.authors       = ['Dominik Schöler']
+  spec.email         = ['dominik.schoeler@makandra.de']
+  spec.summary       = %q{Kickstart Rails development}
+  spec.description   = %q{Katapult is a framework for generating base code}
+  spec.homepage      = 'https://github.com/makandra/katapult'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_runtime_dependency 'rails'
+  spec.add_runtime_dependency 'spring' # speed-up
+
+  # Development
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+
+  # Testing
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'guard-cucumber'
+  spec.add_development_dependency 'rspec'
+end

data/lib/generators/katapult/basics/basics_generator.rb

@@ -0,0 +1,95 @@
+# Generates model-independent application basics (see method names).
+
+module Katapult
+  module Generators
+    class BasicsGenerator < Rails::Generators::Base
+
+      SKIP_GEMS = %w(sass-rails coffee-rails turbolinks sdoc uglifier)
+
+      desc 'Generate basics like test directories and gems'
+      source_root File.expand_path('../templates', __FILE__)
+
+
+      def write_database_ymls
+        template 'config/database.yml', force: true
+        template 'config/database.sample.yml'
+      end
+
+      # Overwrite Gemfile with the template, but transfer all gems that are not
+      # skipped (see SKIP_GEMS).
+      def enhance_gemfile
+        gem_lines = File.readlines('Gemfile').select{ |line| line =~ /^gem/ }
+        @original_gems = gem_lines.reject do |line|
+          line =~ /'(#{ SKIP_GEMS.join '|' })'/
+        end
+
+        template 'Gemfile', force: true
+      end
+
+      def bundle_install
+        bundle 'install'
+      end
+
+      def remove_turbolinks_js
+        gsub_file 'app/assets/javascripts/application.js', "//= require turbolinks\n", ''
+      end
+
+      def setup_spring
+        bundle 'exec spring binstub --all'
+        template 'config/spring.rb'
+        run 'spring stop' # reload
+      end
+
+      def add_modularity_load_paths
+        # This results in correct formatting :)
+        application <<-'LOAD_PATHS'
+config.autoload_paths << "#{Rails.root}/app/controllers/shared"
+    config.autoload_paths << "#{Rails.root}/app/models/shared"
+    config.autoload_paths << "#{Rails.root}/app/util"
+    config.autoload_paths << "#{Rails.root}/app/util/shared"
+        LOAD_PATHS
+      end
+
+      def install_cucumber
+        generate 'cucumber:install'
+
+        template 'features/support/paths.rb'
+        template 'features/support/env-custom.rb'
+      end
+
+      def install_rspec
+        generate 'rspec:install'
+
+        # Do not show Ruby warnings in RSpec runs.
+        gsub_file '.rspec', "--warnings\n", ''
+
+        inject_into_file 'spec/rails_helper.rb', after: "require 'rspec/rails'\n" do
+          "require 'shoulda/matchers'\n"
+        end
+      end
+
+      def install_styles
+        remove_file 'app/assets/stylesheets/application.css'
+        directory 'app/assets/stylesheets', force: true
+      end
+
+      # def install_capistrano
+      #   capify!
+      #   template 'config/deploy.rb'
+      # end
+
+      private
+
+      def app_name
+        File.basename(Dir.pwd)
+      end
+
+      def bundle(command)
+        Bundler.with_clean_env do
+          run 'bundle ' + command
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/katapult/basics/templates/Gemfile

@@ -0,0 +1,76 @@
+source 'https://rubygems.org'
+
+# from original Gemfile
+<%= @original_gems.join %>
+
+# engines
+gem 'haml-rails'
+
+# internal
+gem 'exception_notification'
+gem 'breach-mitigation-rails'
+
+# better coding
+gem 'modularity'
+gem 'edge_rider'
+gem 'andand'
+
+# models
+gem 'has_defaults'
+gem 'assignable_values'
+
+# gem 'carrierwave'
+# gem 'mini_magick'
+
+# gem 'spreadsheet'
+# gem 'vcard'
+
+# views
+# gem 'simple_form'
+# gem 'nested_form'
+gem 'will_paginate'
+gem 'makandra-navy', require: 'navy'
+
+# assets
+gem 'bootstrap-sass'
+gem 'sass-rails'
+gem 'autoprefixer-rails'
+gem 'coffee-rails'
+gem 'uglifier'
+gem 'compass-rails'
+gem 'compass-rgbapng'
+
+group :development do
+  gem 'query_diet'
+  gem 'better_errors'
+  gem 'binding_of_caller'
+  gem 'thin'
+
+  gem 'guard-livereload', require: false
+  gem 'rack-livereload'
+  gem 'spring-commands-rspec'
+  gem 'spring-commands-cucumber'
+end
+
+group :development, :test do
+  gem 'byebug'
+  gem 'factory_girl_rails'
+  gem 'rspec-rails'
+end
+
+group :test do
+  gem 'parallel_tests'
+  gem 'database_cleaner'
+  gem 'timecop'
+  gem 'launchy'
+
+  gem 'capybara'
+  gem 'cucumber-rails', require: false
+  gem 'cucumber_factory'
+  gem 'cucumber_spinner'
+  gem 'selenium-webdriver'
+  gem 'spreewald'
+
+  gem 'rspec_candy'
+  gem 'shoulda-matchers', require: false
+end

data/lib/generators/katapult/basics/templates/app/assets/stylesheets/application.css.sass

@@ -0,0 +1,6 @@
+$body-bg: #ddd
+
+@import compass
+@import bootstrap
+
+@import application/blocks/all

data/lib/generators/katapult/basics/templates/app/assets/stylesheets/application/blocks/_all.css.sass

@@ -0,0 +1,4 @@
+@import items
+@import layout
+@import navigation
+@import tools

data/lib/generators/katapult/basics/templates/app/assets/stylesheets/application/blocks/_items.css.sass

@@ -0,0 +1,11 @@
+table.items
+  @extend .table
+  @extend .table-striped
+
+.items__actions
+  @extend .btn-group
+
+.items__action
+  @extend .btn
+  @extend .btn-default
+  @extend .btn-xs

data/lib/generators/katapult/basics/templates/app/assets/stylesheets/application/blocks/_layout.css.sass

@@ -0,0 +1,26 @@
+@import compass/css3/box-shadow
+@import bootstrap/variables
+
+.layout
+  margin: 100px auto
+  width: 800px
+
+  background-color: white
+  +single-box-shadow
+
+.layout__head
+  padding: 10px 35px
+
+  color: #fff
+  background-color: $brand-primary
+
+.layout__main
+  padding: 20px 35px
+
+.layout__tail
+  padding: 10px 35px
+
+  color: $gray-light
+  background-color: $gray-lighter
+  border-top: 1px solid darken($gray-lighter, 10%)
+  font-size: $font-size-small

data/lib/generators/katapult/basics/templates/app/assets/stylesheets/application/blocks/_navigation.css.sass

@@ -0,0 +1,11 @@
+.navy-layouted-sections
+  @extend .btn-group
+
+.navy-section
+  @extend .btn
+  @extend .btn-info
+
+  text-transform: uppercase
+
+  &.navy-current
+    @extend .btn-default

data/lib/generators/katapult/basics/templates/app/assets/stylesheets/application/blocks/_tools.css.sass

@@ -0,0 +1,12 @@
+@import bootstrap/variables
+
+.tools
+  @extend .btn-group
+  margin-bottom: $line-height-computed / 2
+
+.tools__button
+  @extend .btn
+  @extend .btn-default
+
+.tools__button.is_primary
+  @extend .btn-primary

data/lib/generators/katapult/basics/templates/config/database.sample.yml

@@ -0,0 +1,16 @@
+common: &common
+  adapter: mysql2
+  encoding: utf8
+  username: root
+  password:
+
+development:
+  <<: *common
+  database: <%= app_name %>_development
+
+test: &test
+  <<: *common
+  database: <%= app_name %>_test<%%= ENV['TEST_ENV_NUMBER'] %>
+
+cucumber:
+  <<: *test

data/lib/generators/katapult/basics/templates/config/database.yml

@@ -0,0 +1,13 @@
+common: &common
+  adapter: mysql2
+  encoding: utf8
+  username: katapult
+  password: secret
+
+development:
+  <<: *common
+  database: <%= app_name %>_development
+
+test:
+  <<: *common
+  database: <%= app_name %>_test<%%= ENV['TEST_ENV_NUMBER'] %>

data/lib/generators/katapult/basics/templates/config/spring.rb

@@ -0,0 +1,3 @@
+# Custom generator templates are put into lib/templates.
+FileUtils.mkdir_p 'lib/templates'
+Spring.watch 'lib/templates'

data/lib/generators/katapult/basics/templates/features/support/env-custom.rb

@@ -0,0 +1,3 @@
+require 'rspec' # it does not work without explicitly doing this. why??
+require 'rspec_candy/all'
+require 'spreewald/all_steps'

data/lib/generators/katapult/basics/templates/features/support/paths.rb

@@ -0,0 +1,47 @@
+module NavigationHelpers
+
+  def path_to(page_name)
+    case page_name
+
+    when /^the list of (.*?)$/
+      models_prose = $1
+      route = "#{model_prose_to_route_segment(models_prose)}_path"
+      send(route)
+
+    when /^the (page|form) for the (.*?) above$/
+      action_prose, model_prose = $1, $2
+      route = "#{action_prose == 'form' ? 'edit_' : ''}#{model_prose_to_route_segment(model_prose)}_path"
+      model = model_prose.classify.constantize
+      send(route, model.last)
+
+    when /^the (page|form) for the (.*?) "(.*?)"$/
+      action_prose, model_prose, identifier = $1, $2, $3
+      path_to_show_or_edit(action_prose, model_prose, identifier)
+
+    when /^the (.*?) (page|form) for "(.*?)"$/
+      model_prose, action_prose, identifier = $1, $2, $3
+      path_to_show_or_edit(action_prose, model_prose, identifier)
+
+    when /^the (.*?) form$/
+      model_prose = $1
+      route = "new_#{model_prose_to_route_segment(model_prose)}_path"
+      send(route)
+
+    end
+  end
+
+  private
+
+  def path_to_show_or_edit(action_prose, model_prose, identifier)
+    model = model_prose.classify.constantize
+    route = "#{action_prose == 'form' ? 'edit_' : ''}#{model_prose_to_route_segment(model_prose)}_path"
+    send(route, model.find_by_anything!(identifier))
+  end
+
+  def model_prose_to_route_segment(model_prose)
+    model_prose.gsub(/[\ \/]/, '_')
+  end
+
+end
+
+World(NavigationHelpers)

data/lib/generators/katapult/cucumber_features/cucumber_features_generator.rb

@@ -0,0 +1,23 @@
+require 'katapult/generator'
+
+module Katapult
+  module Generators
+    class CucumberFeaturesGenerator < Katapult::Generator
+
+      desc 'Generate Cucumber features for CRUD'
+      source_root File.expand_path('../templates', __FILE__)
+
+
+      def create_crud_feature
+        template 'feature.feature', "features/#{model.name(:variables)}.feature"
+      end
+
+      private
+
+      def model
+        @element
+      end
+
+    end
+  end
+end

data/lib/generators/katapult/cucumber_features/templates/feature.feature

@@ -0,0 +1,59 @@
+Feature: <%= model.name(:human_plural).titleize %>
+
+  Scenario: CRUD <%= model.name(:human_plural) %>
+    Given I am on the list of <%= model.name(:variables) %>
+
+    # create
+    When I follow "Add <%= model.name(:variable) %>"
+<% model.attrs.each do |attr| -%>
+  <%- if attr.assignable_values -%>
+      And I select "<%= attr.test_value %>" from "<%= attr.name.humanize %>"
+  <%- else -%>
+    <%- case attr.type -%>
+    <%- when :string, :email, :url, :integer, :money, :text, :markdown, :datetime -%>
+      And I fill in "<%= attr.name.humanize %>" with "<%= attr.test_value %>"
+    <%- when :flag -%>
+      And I check "<%= attr.name.humanize %>"
+    <%- end -%>
+  <%- end -%>
+<% end -%>
+      And I press "Save"
+
+    # read
+    Then I should be on the page for the <%= model.name(:variable) %> above
+<% model.attrs.each do |attr| -%>
+  <%- case attr.type -%>
+    <%- when :string, :email, :url, :integer, :money, :text, :markdown -%>
+      And I should see "<%= attr.test_value %>"
+  <%- when :flag -%>
+      And I should see "<%= attr.name.humanize %> Yes"
+  <%- when :datetime -%>
+      And I should see "<%= I18n.localize(attr.test_value) %>"
+  <%- end -%>
+<% end -%>
+
+    # update
+    When I follow "Edit"
+    Then I should be on the form for the <%= model.name(:variable) %> above
+<% model.attrs.each do |attr| -%>
+  <%- if attr.assignable_values -%>
+      And "<%= attr.test_value %>" should be selected for "<%= attr.name.humanize %>"
+  <%- else -%>
+    <%- case attr.type -%>
+    <%- when :string, :email, :url, :integer, :money, :text, :markdown, :datetime -%>
+      And the "<%= attr.name.humanize %>" field should contain "<%= attr.test_value %>"
+    <%- when :flag -%>
+      And the "<%= attr.name.humanize %>" checkbox should be checked
+    <%- end -%>
+  <%- end -%>
+<% end -%>
+
+<% if model.label_attr # do not crash when the model has no label attr -%>
+    # destroy
+    When I go to the list of <%= model.name(:variables) %>
+    Then I should see "<%= model.label_attr.test_value %>"
+
+    When I follow "Destroy"
+    Then I should be on the list of <%= model.name(:variables) %>
+      But I should not see "<%= model.label_attr.test_value %>"
+<% end -%>