katapult 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b262aea45a6e72401c0cee7d558e0320e3fe4a1
+  data.tar.gz: c252ae0b85dd9bd0cf682910a22212bff6058e70
+SHA512:
+  metadata.gz: 9a96e6f9ab0445e68bbf35bfa69a8dd2c9122ed212bc6c086a4f402ca57a11d717b5885c805702ba237b109e2439a5be06cefdfcba28eea4b7947c66f2cf39d9
+  data.tar.gz: b1ee95eb5749a091c3e9d4ed3dd95a209e816cd6c92dfd313a27df545ffb2bac83252988ea0b4b50f8cd21578109fa94968d658a6d9946adc39f07c252692674

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.pt_project_id

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  
+  watch(%r{^lib/generators/katapult/.+/.+_generator\.rb$}) { 'features/katapult.feature:12' }
+  watch(%r{^lib/katapult/.+\.rb$}) { 'features/katapult.feature:12' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dominik
+
+MIT License
+
+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,122 @@
+# Katapult
+
+<img src="katapult.png" width="200px" align="right" />
+
+
+`Katapult` is a kickstart generator for Rails applications. It creates
+application basics and generates (makandra-flavored) code from an application
+model, significantly speeding up the initial phase of a Rails project.
+
+`Katapult` will always support current versions of Ruby and Rails, currently
+Rails 4.1 and Ruby 2.1.
+
+
+## Installation
+
+As `katapult` is designed to *start* Rails applications, it works best with a
+clean new Rails app. To create one, run
+
+    katapult target MY_APPLICATION_NAME
+
+This will add the `katapult` gem to the Gemfile and then integrate `katapult`
+by running
+
+    rails generate katapult:install
+    rails generate katapult:basics
+
+
+It will install application basics, such as a `database.yml`, basics styles as
+well as RSpec and Cucumber and prepare `lib/katapult/application_model.rb`
+where you will draft your application.
+
+### Manual installation
+You may also integrate the gem into an existing Rails application. Just add it to the Gemfile and run the generators stated above.
+
+
+## Usage
+
+After installation, you find a file `lib/katapult/application_model.rb` where
+you will define the properties of your application. Inside this file, use
+`katapult`'s simple DSL (domain specific language) to express yourself.
+
+The DSL consists of elements, e.g. Model or WUI (which stands for *Web User
+Interface*). Each `katapult` element has the same syntax, taking a name,
+options, and a block:
+
+    element_type 'name', options: 'example' do |element|
+      element.some_method
+    end
+
+
+### Model
+Takes a name and a block:
+
+    model 'Customer' do |customer|
+      # ...
+    end
+
+
+#### Attribute
+Defined on Model. Takes a name and options:
+
+    model.attr :email
+    model.attr :age, type: :integer, assignable_values: 18..99, allow_blank: true
+    model.attr :income, type: :money
+    model.attr :homepage, type: :url, default: 'http://www.makandra.de'
+    model.attr :locked, type: :flag, default: false
+
+
+### WUI (Web User Interface)
+Takes a name, options and a block:
+
+    wui 'Customer', model: 'User' do |wui|
+      # ...
+    end
+
+
+#### Action
+Defined on WUI. Takes a name and options:
+
+    wui.action :index
+    wui.action :show
+    wui.action :create # also creates :new
+    wui.action :update # also creates :edit
+    wui.action :destroy
+    wui.crud   # creates all the standard rails actions above
+    wui.action :custom_action, method: :post, scope: :member
+    wui.action :other_action, method: :get, scope: :collection
+
+
+### Navigation
+Takes a name, will generate a navigation with links to the index pages of all
+WUIs.
+
+    navigation :main
+
+
+## Contributing
+
+<!-- 1. Fork it ( http://github.com/<my-github-username>/katapult/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request -->
+
+`Katapult` caches a pristine Rails application inside its `tmp/` directory to
+speed up test runs. Keep this in mind, as it may lead to caching issues when
+switching Ruby versions or installing a new version of the Rails gem.
+
+Since `katapult` has full-stack integration tests, it requires a MySQL account.
+Create a dedicated account on your MySQL server by running this command in a
+MySQL console (as-is):
+
+    GRANT ALL ON *.* TO 'katapult'@'localhost' IDENTIFIED BY 'secret';
+
+The user `katapult` is hereby granted any action (SELECT, UPDATE, etc. except
+for granting privileges) on any database and table (`*.*`).
+
+
+## Credits
+
+Development: Dominik Schöler from [makandra](makandra.com)<br />
+Katapult image: [Nemo](http://pixabay.com/de/katapult-30061)

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+task :default => :tests
+
+task :tests => [:spec, :features]
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/katapult

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/katapult/util'
+
+case (command = ARGV.shift)
+when 'target'
+  app_name = ARGV.shift
+
+  puts 'Creating new Rails application ...'
+  system "rails new #{app_name} --skip-test-unit --skip-bundle --database mysql"
+
+  Dir.chdir app_name
+
+  puts
+  puts 'Initializing git repository ...'
+  system 'git init'
+  Katapult::Util.git_commit "rails new #{app_name}"
+
+  puts
+  puts 'Installing katapult ...'
+  File.open('Gemfile', 'a') do |file|
+    file.puts "gem 'katapult'#{ ENV['KATAPULT_GEMFILE_OPTIONS'] }"
+  end
+  system 'bundle install'
+  system 'bundle exec rails generate katapult:install'
+  Katapult::Util.git_commit 'rails generate katapult:install'
+
+  puts
+  puts 'Generating katapult basics ...'
+  system 'bundle exec rails generate katapult:basics'
+  Katapult::Util.git_commit 'rails generate katapult:basics'
+
+  puts
+  puts 'Done.'
+
+when 'fire'
+  app_model_path = 'lib/katapult/application_model.rb'
+
+  puts 'Loading katapult ...'
+  system 'bin/rails generate katapult:transform ' + app_model_path
+
+else
+  puts 'Usage: katapult [target APP_NAME | fire]'
+end

data/features/binary.feature

@@ -0,0 +1,48 @@
+Feature: Katapult binary `katapult`
+
+  Scenario: Start new Rails application
+    Given The default aruba timeout is 120 seconds
+
+    When I successfully run `katapult target binary_test`
+    Then the output should contain "Creating new Rails application"
+    And the output should contain "Installing katapult"
+    And the output should contain "Generating katapult basics"
+    And the output should contain "Done."
+
+    When I cd to "binary_test"
+
+    # test whether katapult is installed
+    Then the file "Gemfile" should contain "gem 'katapult'"
+    And a file named "lib/katapult/application_model.rb" should exist
+
+    # test whether the application is already bundled
+    When I run `bundle check`
+    Then the output should contain "The Gemfile's dependencies are satisfied"
+
+    # test whether katapult made git commits
+    When I run `git log`
+    Then the output should contain "rails new binary_test"
+    And the output should contain "rails generate katapult:install"
+    And the output should contain "rails generate katapult:basics"
+    And the output should contain "Author: katapult <katapult@makandra.com>"
+
+
+  Scenario: Forget to pass application name
+    When I run `katapult target # without app name`
+    Then the output should contain "No value provided for required arguments 'app_path'"
+
+
+  Scenario: Run without arguments
+    When I run `katapult # without arguments`
+    Then the output should contain "Usage: katapult [target APP_NAME | fire]"
+
+
+  Scenario: Transform the application model
+    Given a pristine Rails application
+    And I install katapult
+    And I generate katapult basics
+
+    When I run `katapult fire`
+    Then the output should contain "Loading katapult"
+    And the output should contain "parse  lib/katapult/application_model"
+    And the output should contain "render  into katapult_test_app"

data/features/configuration.feature

@@ -0,0 +1,24 @@
+Feature: Configure katapult
+
+  Background:
+    Given a pristine Rails application
+    And I install katapult
+    And I generate katapult basics
+
+
+  Scenario: Custom model template
+    When I overwrite "lib/katapult/application_model.rb" with:
+      """
+      model 'Car'
+      """
+    And a file named "lib/templates/katapult/model/model.rb" with:
+      """
+      # custom model template for <%= class_name %>
+
+      """
+    And I successfully transform the application model
+    Then the file "app/models/car.rb" should contain exactly:
+      """
+      # custom model template for Car
+
+      """

data/features/katapult.feature

@@ -0,0 +1,201 @@
+Feature: Katapult in general
+
+  Background:
+    Given a pristine Rails application
+
+
+  Scenario: Install katapult
+    When I install katapult
+    Then the file "lib/katapult/application_model.rb" should contain exactly:
+      """
+      # Here you define the fundamentals of your application.
+      #
+      # Add a model:
+      # model 'customer' do |customer|
+      #   customer.attr :name
+      #   customer.attr :birth, type: :date
+      #   customer.attr :email
+      # end
+      #
+      # Add a web user interface:
+      # wui 'customer' do |wui|
+      #   wui.action :index
+      #   wui.action :show
+      #   wui.action :lock, scope: :member, method: :post
+      # end
+      #
+      # Add navigation
+      # navigation :main
+
+      """
+
+
+  Scenario: Generate basic files and settings
+    Given I install katapult
+    When I generate katapult basics
+    Then the file "Gemfile" should contain exactly:
+      """
+      source 'https://rubygems.org'
+
+      # from original Gemfile
+      gem 'rails', '4.1.0'
+      gem 'mysql2'
+      gem 'jquery-rails'
+      gem 'jbuilder', '~> 2.0'
+      gem 'spring',        group: :development
+      gem 'katapult', path: '../../..'
+
+      # 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
+
+      """
+
+    And the file "config/database.yml" should contain exactly:
+      """
+      common: &common
+        adapter: mysql2
+        encoding: utf8
+        username: katapult
+        password: secret
+
+      development:
+        <<: *common
+        database: katapult_test_app_development
+
+      test: &test
+        <<: *common
+        database: katapult_test_app_test<%= ENV['TEST_ENV_NUMBER'] %>
+
+      cucumber:
+        <<: *test
+      """
+    And the file "config/database.sample.yml" should contain exactly:
+      """
+      common: &common
+        adapter: mysql2
+        encoding: utf8
+        username: root
+        password:
+
+      development:
+        <<: *common
+        database: katapult_test_app_development
+
+      test: &test
+        <<: *common
+        database: katapult_test_app_test<%= ENV['TEST_ENV_NUMBER'] %>
+
+      cucumber:
+        <<: *test
+
+      """
+
+    And the file "features/support/env-custom.rb" should contain:
+      """
+      require 'rspec_candy/all'
+      require 'spreewald/all_steps'
+      """
+    And a file named "features/support/paths.rb" should exist
+    And the file "spec/rails_helper.rb" should contain:
+      """
+      require 'rspec/rails'
+      require 'shoulda/matchers'
+      """
+
+
+
+    # styles
+    And the file "app/assets/stylesheets/application.css.sass" should contain:
+      """
+      @import compass
+      @import bootstrap
+
+      @import application/blocks/all
+
+      """
+    And the file "app/assets/stylesheets/application/blocks/_all.css.sass" should contain exactly:
+      """
+      @import items
+      @import layout
+      @import navigation
+      @import tools
+
+      """
+    And a file named "app/assets/stylesheets/application/blocks/_items.css.sass" should exist
+    And a file named "app/assets/stylesheets/application/blocks/_layout.css.sass" should exist
+    And a file named "app/assets/stylesheets/application/blocks/_navigation.css.sass" should exist
+    And a file named "app/assets/stylesheets/application/blocks/_tools.css.sass" should exist
+
+    # And the file "config/deploy.rb" should contain exactly:
+    #   """
+    #   stages
+    #   """