shoestrap 0.4.1 → 1.0.0.pre1

data/lib/shoestrap/cli.rb

@@ -0,0 +1,35 @@
+require "thor"
+
+require_relative 'application_generator'
+
+module Shoestrap
+  class CLI < Thor
+
+    method_option :css,
+                  :type => :string,
+                  :default => 'bootstrap',
+                  :banner => 'Specify which CSS Framework is used by the Application Generator'
+
+    method_option :database,
+                  :type => :string,
+                  :default => 'postgresql',
+                  :banner => 'Specify which database is used when creating new Rails app'
+
+    method_option :kuhsaft,
+                  :type => :boolean,
+                  :default => true,
+                  :banner => 'Specify wether kuhsaft should be installed'
+
+    desc 'new <application_name>', 'Generate a new rails app with shoestrap'
+
+    def new(application_name)
+      application_generator.start(application_name, options)
+    end
+
+    private
+
+    def application_generator
+      @application_generator ||= ApplicationGenerator
+    end
+  end
+end

data/lib/shoestrap/railtie.rb

@@ -0,0 +1,7 @@
+module Shoestrap
+  class Railtie < ::Rails::Railtie
+    generators do
+      require '../generators/shoestrap/bootstrap_generator'
+    end
+  end
+end

data/lib/shoestrap/shell.rb

@@ -0,0 +1,9 @@
+module Shoestrap
+  module Shell
+    extend self
+
+    def self.exec(command)
+      system "#{command}"
+    end
+  end
+end

data/lib/shoestrap/version.rb

@@ -0,0 +1,3 @@
+module Shoestrap
+  VERSION = "1.0.0.pre1"
+end

data/shoestrap.gemspec

@@ -1,26 +1,33 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shoestrap/version'
 
-Gem::Specification.new do |s|
-  s.name        = "shoestrap"
-  s.version     = '0.4.1'
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Immanuel Häussermann", "Felipe Kaufmann", "Phil Schilter", "Noëlle Rosenberg"]
-  s.email       = "info@screenconcept.ch"
-  s.homepage    = "http://github.com/screenconcept/shoestrap"
-  s.summary     = %q{A tool that helps you bootstrap your rails projects}
-  s.description = %q{shoestrap is a rails app bootstrapper}
+Gem::Specification.new do |spec|
+  spec.name          = "shoestrap"
+  spec.version       = Shoestrap::VERSION
+  spec.authors       = ["Felipe Kaufmann"]
+  spec.email         = ["felipekaufmann@gmail.com"]
+  spec.description   = %q{SC Bootstrapper and Generators}
+  spec.summary       = %q{Rails App Bootstrapper and Generator used at Screen Concept}
+  spec.homepage      = ""
+  spec.license       = "MIT"
 
-  s.rubyforge_project = "shoestrap"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", '2.14.0.rc1'
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "ruby_gntp"
 
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'pry'
-  s.add_dependency 'rails'
-  s.add_dependency 'airbrake'
-  s.add_dependency 'blazing', '0.4.0.beta3'
+  spec.add_dependency 'rails', '4.0.0'
+  spec.add_dependency 'airbrake'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'blazing', '0.4.0.beta3'
 end

data/spec/shoestrap/application_generator_spec.rb

@@ -0,0 +1,170 @@
+require_relative '../../lib/shoestrap/application_generator'
+require_relative '../spec_helper'
+
+module Shoestrap
+  describe ApplicationGenerator do
+
+    let(:default_options) { { css: 'bootstrap', database: 'postgresql', kuhsaft: true } }
+
+    describe '#start' do
+      it 'says it is going to generate an app' do
+        ApplicationGenerator.stub(:shoestrap_generators).and_return(:true)
+        output = capture(:stdout, :stderr) do
+          ApplicationGenerator.start('test_app', default_options)
+        end
+        expect(output).to match(/\[shoestrap\] Generating new Rails Application test_app/)
+      end
+
+      it 'calls rails new with the shoestrap template' do
+        ApplicationGenerator.stub(:shoestrap_generators).and_return(:true)
+        capture(:stdout, :stderr) do
+          expect(Shell).to receive(:exec).with("rails new test_app -m #{File.join(
+                                                             File.dirname(__FILE__).gsub('spec','lib'),
+                                                             '../../templates/application_generator/application_template.rb')} -d postgresql")
+          ApplicationGenerator.start('test_app', default_options)
+        end
+      end
+
+      it 'runs the shoestrap generators' do
+        capture(:stdout, :stderr) do
+          expect(ApplicationGenerator).to receive(:shoestrap_generators)
+          ApplicationGenerator.start('test_app', default_options)
+        end
+      end
+    end
+
+    describe '#shoestrap_generators' do
+
+      before :each do
+        ApplicationGenerator.stub(:setup_bdd_environment)
+        ApplicationGenerator.stub(:setup_database)
+        ApplicationGenerator.stub(:setup_css_framework)
+        ApplicationGenerator.stub(:setup_smacss_files)
+        ApplicationGenerator.stub(:setup_coffee_files)
+        ApplicationGenerator.stub(:setup_kuhsaft)
+        ApplicationGenerator.stub(:install_gems)
+        ApplicationGenerator.stub(:apply_special_sauce)
+        ApplicationGenerator.stub(:setup_mailcatcher)
+        Dir.stub(:chdir).and_yield
+      end
+
+      it 'installs requried gems' do
+        expect(ApplicationGenerator).to receive(:install_gems)
+        ApplicationGenerator.shoestrap_generators('test_app', default_options)
+      end
+
+      it 'sets up the css framework' do
+        expect(ApplicationGenerator).to receive(:setup_css_framework)
+        ApplicationGenerator.shoestrap_generators('test_app', default_options)
+      end
+
+      it 'sets up the smacss files' do
+        expect(ApplicationGenerator).to receive(:setup_smacss_files)
+        ApplicationGenerator.shoestrap_generators('test_app', default_options)
+      end
+
+      it 'sets up the coffee files' do
+        expect(ApplicationGenerator).to receive(:setup_coffee_files)
+        ApplicationGenerator.shoestrap_generators('test_app', default_options)
+      end
+
+      it 'sets up the bdd environment' do
+        expect(ApplicationGenerator).to receive(:setup_bdd_environment)
+        ApplicationGenerator.shoestrap_generators('test_app', default_options)
+      end
+
+      it 'sets up kuhsaft' do
+        expect(ApplicationGenerator).to receive(:setup_kuhsaft)
+        ApplicationGenerator.shoestrap_generators('test_app', default_options)
+      end
+
+      it 'applies special sauce when the correct environment variable is set' do
+        original_value = ENV['GIVE_ME_SPECIAL_SAUCE']
+        ENV['GIVE_ME_SPECIAL_SAUCE'] = "true"
+        expect(ApplicationGenerator).to receive(:apply_special_sauce)
+        ApplicationGenerator.shoestrap_generators('test_app', default_options)
+        ENV['GIVE_ME_SPECIAL_SAUCE'] = original_value
+      end
+
+      it 'does not apply special sauce normally' do
+        original_value = ENV['GIVE_ME_SPECIAL_SAUCE']
+        ENV['GIVE_ME_SPECIAL_SAUCE'] = nil
+        expect(ApplicationGenerator).not_to receive(:apply_special_sauce)
+        ApplicationGenerator.shoestrap_generators('test_app', default_options)
+        ENV['GIVE_ME_SPECIAL_SAUCE'] = original_value
+      end
+    end
+
+    describe '#install_gems' do
+      it 'delegates to the Gem Install Generator' do
+        Shell.stub(:exec)
+        expect(GemInstallGenerator).to receive(:start)
+        ApplicationGenerator.install_gems([])
+      end
+
+      it 'delegates to the Gem Install Generator' do
+        GemInstallGenerator.stub(:start)
+        expect(Shell).to receive(:exec).with('bundle')
+        ApplicationGenerator.install_gems([])
+      end
+    end
+
+    describe '#setup_css_framework' do
+      it 'runs the generator it was called with' do
+        DummyGenerator = double
+        expect(DummyGenerator).to receive('start')
+        ApplicationGenerator.setup_css_framework('dummy')
+      end
+    end
+
+    describe '#setup_smacss_files' do
+      it 'runs the smacss files generator' do
+        expect(SmacssFilesGenerator).to receive('start')
+        ApplicationGenerator.setup_smacss_files
+      end
+    end
+
+    describe '#setup_coffee_files' do
+      it 'runs the coffee files generator' do
+        expect(CoffeeFilesGenerator).to receive('start')
+        ApplicationGenerator.setup_coffee_files
+      end
+    end
+
+    describe '#setup_bdd_environment' do
+      it 'runs the rspec generator' do
+        expect(BddGenerator).to receive('start')
+        ApplicationGenerator.setup_bdd_environment
+      end
+    end
+
+    describe '#setup_kuhsaft' do
+      it 'delegates to the Gem Install Generator' do
+        expect(KuhsaftGenerator).to receive(:start)
+        ApplicationGenerator.setup_kuhsaft
+      end
+    end
+
+    describe '#apply_special_sauce' do
+      it 'calls sauce apply on current directory' do
+        expect(Shell).to receive(:exec).with('sauce apply . --appname=foo')
+        ApplicationGenerator.apply_special_sauce('foo')
+      end
+    end
+
+    describe '#required_gems' do
+      it 'includes kuhsaft by default' do
+        pending "waiting for kuhsaft pre-release"
+        #expect(ApplicationGenerator.required_gems(default_options)).to include('kuhsaft')
+      end
+
+      it 'includes bootstrap-sass by default' do
+        expect(ApplicationGenerator.required_gems(default_options)).to include('bootstrap-sass')
+      end
+
+      it 'includes zurb-foundation when css option is set to foundation' do
+        expect(ApplicationGenerator.required_gems(default_options.merge( css: 'foundation' ))).to include('zurb-foundation')
+      end
+    end
+  end
+end

data/spec/shoestrap/cli_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../../lib/shoestrap/cli'
+require_relative '../spec_helper'
+
+module Shoestrap
+  describe CLI do
+
+    subject { CLI }
+
+    describe '#new' do
+      it 'delegates to ApplicationGenerator' do
+        expect(ApplicationGenerator).to receive(:start)
+        subject.start(['new', 'foo'])
+      end
+
+      it 'does not delegate to ApplicationGenerator when no application name is provided' do
+        capture(:stdout, :stderr) do
+          expect(ApplicationGenerator).not_to receive(:start)
+          subject.start(['new'])
+        end
+      end
+
+      it 'passes bootstrap & postgresql & kuhsaft as default to the ApplicationGenerator' do
+        expect(ApplicationGenerator).to receive(:start).with('test_app', { 'css' => 'bootstrap', 'database' => 'postgresql', 'kuhsaft' => true })
+        subject.start(['new', 'test_app'])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'rspec'
+
+#
+# Override Shoestrap::Shell.exec so no acutal shelling out
+# happens when running tests.
+#
+# You can set expectations for system calls like so:
+# Shell.expects(:exec).with('rails new test_app')
+#
+module Shoestrap
+  module Shell
+    extend self
+
+    def self.exec(command)
+      puts "#{command}"
+    end
+  end
+end
+
+#
+# Use capture to silece and capture stderr/stdout
+# Useful to hide logged messages etc. in test run
+#
+def capture(*streams)
+  streams.map! { |stream| stream.to_s }
+  begin
+    result = StringIO.new
+    streams.each { |stream| eval "$#{stream} = result" }
+    yield
+  ensure
+    streams.each { |stream| eval("$#{stream} = #{stream.upcase}") }
+  end
+  result.string
+end

data/templates/application_generator/application.html.haml

@@ -0,0 +1,51 @@
+!!! 5
+/[if lt IE 7] <html class='no-js lt-ie9 lt-ie8 lt-ie7'>
+/[if IE 7] <html class='no-js lt-ie9 lt-ie8'>
+/[if IE 8] <html class='no-js lt-ie9'>
+/[if gt IE 8]><!
+%html.no-js{ lang: I18n.locale }
+  / <![endif]
+  %head
+    %title= content_for?(:title) ? yield(:title) : 'Untitled'
+
+    %meta{ charset: 'utf-8' }
+    %meta{ 'http-equiv' => 'X-UA-Compatible', content: 'IE=edge,chrome=1' }
+    %meta{ name: 'keywords', content: '' }
+    %meta{ name: 'description', content: '' }
+    %meta{ name: 'viewport', content: 'width=device-width, initial-scale=1.0' }
+
+    -# Favicons
+    = favicon_link_tag('favicons/favicon-sc-129x129.png', rel: 'apple-touch-icon', type: 'image/png')
+    = favicon_link_tag('favicons/favicon-sc-32x32.png', rel: 'icon', type: 'image/png')
+    <!--[if IE]>
+    = favicon_link_tag('favicons/favicon-sc-16x16.ico')
+    <![endif]-->
+
+    -# Typekit
+    = javascript_include_tag '//use.typekit.net/XXXX.js', :media => 'all'
+    :javascript
+      try{Typekit.load();}catch(e){}
+
+    = stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true
+    = javascript_include_tag 'modernizr', 'data-turbolinks-track' => true
+    = csrf_meta_tags
+
+  %body{ class: body_class }
+    = render_navigation
+
+    = yield
+
+    -# Application JavaScripts
+    = javascript_include_tag 'application', 'data-turbolinks-track' => true
+
+    -# Selectivizr
+    <!--[if lte IE 8]>
+    = javascript_include_tag 'selectivizr'
+    <![endif]-->
+
+    -# Google Analytics
+    :javascript
+      var _gaq=[['_setAccount','UA-XXXXX-X'],['_trackPageview'],['_trackPageLoadTime']];
+      (function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];g.async=1;
+      g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
+      s.parentNode.insertBefore(g,s)}(document,'script'));

data/templates/application_generator/application_helper.rb

@@ -0,0 +1,6 @@
+module ApplicationHelper
+
+  def body_class
+    "controller-#{controller_name} action-#{action_name}"
+  end
+end

data/templates/application_generator/application_template.rb

@@ -0,0 +1,72 @@
+#
+# SC Rails Application Template
+#
+def source_paths
+  [File.expand_path(File.dirname(__FILE__))]
+end
+
+#
+# Locale and Timezone
+#
+application "config.time_zone = 'Bern'"
+application "config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}').to_s]"
+application "config.i18n.available_locales = [:de]"
+application "config.i18n.default_locale = :de"
+
+inject_into_file 'config/application.rb', :after => "Application < Rails::Application" do
+  <<-eos
+    # Customize generators
+    config.generators do |g|
+      g.stylesheets false
+      g.form_builder :simple_form
+      g.template_engine :haml
+      g.test_framework :rspec
+      g.javascripts false
+      g.assets false
+      g.helper false
+    end
+  eos
+end
+
+#
+# Default Gems (others are added to gemfile by individual generators called after app generation)
+#
+gem 'simple_form', '3.0.0.rc'
+gem 'haml'
+gem 'haml-rails'
+gem 'simple-navigation'
+gem 'mail'
+gem 'fabrication'
+gem 'shoestrap'
+gem 'kuhsaft'
+gem 'selectivizr-rails'
+gem 'modernizr-rails'
+gem 'bourbon'
+
+gem_group :development, :test do
+  gem 'pry'
+  gem 'ruby_gntp'
+  gem 'rspec-rails'
+  gem 'guard-rspec'
+  gem 'guard-spring'
+end
+
+gem_group :test do
+  gem 'database_cleaner'
+end
+
+#
+# Application layout
+#
+remove_file "app/views/layouts/application.html.erb"
+copy_file "application.html.haml", "app/views/layouts/application.html.haml"
+
+#
+# Application helper
+#
+copy_file "application_helper.rb", "app/helpers/application_helper.rb", force: true
+
+#
+# Favicons
+#
+directory "favicons", "app/assets/images/favicons/"