shoestrap 0.4.1 → 1.0.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9791492dd8bd44bbc69b59cee2871160915eccee
+  data.tar.gz: 1f8a4e2e50a56425a0fc55cd561455fb0e944214
+SHA512:
+  metadata.gz: 4d9896bbaff16d24ac9525b9894bdc7f579eb91f8a36f409c3336dd3abe4bdf276ed571937320c44dad34b0e6b453faf3dd8ad7026905736a8f6d6089f342047
+  data.tar.gz: c0e40359529e4552bdf63fa84f4fcdfb4e0a64e726cfd3143fc0f9254087f6f048dfee0cf291a5590452a8a74c025a9edeaac18d8efd1e45534d1a170ed3cb95

data/.gitignore

@@ -1,19 +1,18 @@
-.bundle/
-log/*.log
-pkg/
-spec/dummy/db/*.sqlite3
-spec/dummy/log/*.log
-spec/dummy/tmp/
-spec/dummy/db/migrate/*.rb
-spec/dummy/db/schema.rb
-spec/dummy/public/stylesheets/*
-spec/dummy/public/uploads/tmp/*
-spec/dummy/public/uploads/kuhsaft/*
-spec/dummy/public/uploads/*
-spec/dummy/public/images/**/*
-spec/dummy/public/javascripts/**/*
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
 Gemfile.lock
-.DS_Store
-.sass-cache
-tags
-.idea
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+project-notes.txt

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format nested
+--format d

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -1,13 +1,6 @@
-language: ruby
+---
 rvm:
-  - "1.8.7"
-  - "1.9.2"
-  - "1.9.3"
-  - jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
-  - rbx-19mode
+- 2.0.0
 notifications:
-  campfire: "AylPbg/2kJ8sHjuLGfc0rcDFO5LDSNa+kuH5trCYiLzGD+4hkpftqkvRWyWN\nW3GSOIU32elrb3wqo2jU22c5dhQoYtEgV0Cpv25X4kY2aTlMqSAkCc2Uywxb\n8bmIM3VThTolQUw9F5nhM9aw7wzVXDufSsOwQqUftEmJ2yjrTh4="
-# uncomment this line if your project needs to run something other than `rake`:
-# script: bundle exec rspec spec
+  hipchat:
+    secure: "RfG5xaMJ9Lgrusw9G34fqBd+AkHXWIEMFtwc4KRNUR4nfwLnuJi/Ekpkd2rc\n09CL19vm+uyHSL90PStSYZ7KLvYH7OGq/M1I0lLNZFTkCMnpNKyxwCr+Pk6l\nughm/FT0ablL7dE/isoDttRb6o//tpiv9sREib2DvIgzleciA0g="

data/CHANGELOG.md

@@ -1,4 +1,18 @@
-#Changelog
+# CHANGELOG
+
+## 1.0.0.pre1 - 2013-07-17
+
+Started from scratch for a clean, test driven implementation.
+A few notable changes:
+
+- the application generator is now implemented as a standard
+  rails application template instead of hooking into Rails.
+
+- Everything deployment related has been extracted into
+  another gem.
+
+- For now, only app generation works, the CMS Scaffolding generators
+  still have to be ported/implemented.
 
 ## 0.4.1 - 2013-06-03
 

data/CONTRIBUTING

@@ -0,0 +1 @@
+# Contributing Guideline

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec, :cli => "--color --format nested --fail-fast" do
+  # with Minitest::Spec
+  watch(%r|^lib/shoestrap.rb|)        { "spec" }
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE

@@ -1,7 +1,20 @@
-Copyright (c) 2011 Screen Concept©
+Copyright (c) 2013 Screen Concept
 
-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:
+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 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.
+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

@@ -1,28 +1,46 @@
-[![Build Status](https://api.travis-ci.org/screenconcept/shoestrap.png)](http://travis-ci.org/screenconcept/shoestrap)
+[![Build Status](https://travis-ci.org/screenconcept/shoestrap.png)](https://travis-ci.org/screenconcept/shoestrap)
+[![Code Climate](https://codeclimate.com/github/screenconcept/shoestrap.png)](https://codeclimate.com/github/screenconcept/shoestrap)
+[![Gem Version](https://badge.fury.io/rb/shoestrap.png)](http://badge.fury.io/rb/shoestrap)
 
-# Shoestrap
+# shoestrap
 
-Shoestrap is Screen Concept's Rails App bootstrapper, very similar and
-heavily inspired by https://github.com/thoughtbot/suspenders.
+Shoestrap is used @ Screen Concept for generating new Rails Apps and creating admin
+backends. Shoestrap is pretty opinionated and tailored to the way we
+work. Your mileage may vary!
 
-It is currently under heavy development.
+# Features
 
-# Installation
+* generate new rails apps with a sc flavored setup
+* generate admin backens similar to rails_admin and ative_admin, with
+  some notable differences:
 
-`gem install shoestrap`
+  TBD: elaborate on differences between rails_admin/active_admin, i.e
+  why whe built it
 
-# Using Shoestrap
+## Test shoestrap "compliance"
 
-## Create a shoestrapped Rails Application
+You can check how much your existing Applicaiton complies with the
+current shoestrap featureset by running the integration tests against
+your application. You can do this via the `TARGET_APP` environment
+variable:
 
-`shoestrap <app_name>`
+`TARGET_APP=../some_rails_project rake features`
 
-## Using shoestrap generators
+# Development & Contributing
 
-Add shoestrap to your Gemfile.
+See the CONTRIBUTING file for project specific guidelines.
 
-Run `rails generate shoestrap:cms cms/ModelName` to generate CMS Backend
-views. The cms/ prefix is necessary!
+## Run specs in DEBUG mode
+
+You can run the integration tests in debug mode. The test helpers that
+generate the dummy apps will then be more verbose:
+
+`DEBUG=true rake features`
+
+If you don't want debug mode anymore, remember to unset the DEBUG
+variable:
+
+`unset DEBUG`
 
 # License
 

data/Rakefile

@@ -1,17 +1,18 @@
-require 'bundler'
-require 'rake/clean'
-#require 'rdoc/task'
+require "bundler/gem_tasks"
+require 'rake/testtask'
 require 'rspec/core/rake_task'
 
-include Rake::DSL
-
-Bundler::GemHelper.install_tasks
-
 desc "Run specs"
 RSpec::Core::RakeTask.new do |t|
-  # t.rspec_opts = %w(--colour --fail-fast --format nested)
-  t.rspec_opts = %w(--colour  --format nested)
+  t.rspec_opts = %w(--color --format nested)
+  t.ruby_opts  = %w(-w)
+end
+
+RSpec::Core::RakeTask.new(:features) do |t|
+  t.rspec_opts = %w(--color --format nested)
   t.ruby_opts  = %w(-w)
+  t.pattern = 'features/**/*_feature.rb'
+  t.verbose = true
 end
 
-task :default => [:spec]
+task :default => [:spec, :features]

data/bin/shoestrap

@@ -1,12 +1,4 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join('..', 'lib', 'generators', 'shoestrap', 'app_generator'), File.dirname(__FILE__))
-require File.expand_path(File.join('..', 'lib', 'shoestrap', 'app_builder'), File.dirname(__FILE__))
-
-templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
-
-Shoestrap::AppGenerator.source_root templates_root
-Shoestrap::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
-
-Shoestrap::AppGenerator.start
-
+require_relative '../lib/shoestrap/cli'
+Shoestrap::CLI.start(ARGV)

data/features/features_helper.rb

@@ -0,0 +1,91 @@
+require 'rspec'
+require 'fileutils'
+require 'digest'
+require 'pry'
+
+RSpec.configure do |c|
+  c.after(:suite) do
+    clean_up
+  end
+end
+
+# TODO: spec these helpers!
+
+def generate_test_app_with_shoestrap(options=nil)
+  `createuser -s #{test_app_key(options)}`
+  unless ENV['TARGET_APP'] || File.exists?(test_app_path(options))
+    if ENV['DEBUG']
+      puts "generating test app in #{test_app_path(options)}"
+      puts "#{File.join(File.dirname(__FILE__), '../bin/shoestrap')} new #{test_app_path(options)} #{options}"
+      system "#{File.join(File.dirname(__FILE__), '../bin/shoestrap')} new #{test_app_path(options)} #{options}"
+    else
+      `#{File.join(File.dirname(__FILE__), '../bin/shoestrap')} new #{test_app_path(options)} #{options}`
+    end
+  end
+end
+
+def reload_application_gemfile(options=nil)
+  ENV['BUNDLE_GEMFILE'] = File.join(application_path(options), 'Gemfile')
+  require 'bundler'
+  Bundler.require(:default)
+end
+
+def clean_up
+  puts
+  puts 'cleaning up...'
+  remove_test_dbs
+  remove_test_apps
+  puts
+  puts
+end
+
+def test_apps
+  Dir.entries(File.join(File.dirname(__FILE__))).select do |entry|
+    entry.include? 'test_app'
+  end.map { |e| "features/#{e}" }
+end
+
+def remove_test_apps
+  test_apps.each do |app|
+    puts "removing test app #{File.expand_path(app)}"
+    FileUtils.rm_rf(app)
+  end
+end
+
+def remove_test_dbs
+  test_apps.each do |app|
+    Dir.chdir app do
+      puts "dropping test db for #{app}" if ENV['DEBUG']
+      ENV['BUNDLE_GEMFILE'] = File.join(Dir.pwd, 'Gemfile')
+      require 'bundler'
+      Bundler.require(:default)
+      `bundle exec rake db:drop`
+    end
+  end
+end
+
+def application_path(options = nil)
+  target_app_path || test_app_path(options)
+end
+
+def target_app_path
+  ENV['TARGET_APP']
+end
+
+def test_app_path(options = nil)
+  File.join(File.dirname(__FILE__), test_app_key(options))
+end
+
+def application_file(file, options = nil)
+  File.read(File.join(application_path(options), file))
+end
+
+def test_app_key(options)
+  "test_app#{options.to_s.digest}"
+end
+
+class String
+  def digest
+    "_#{Digest::MD5.hexdigest(self)}" unless self.empty?
+  end
+end

data/features/shoestrap/commands/new_command_feature.rb

@@ -0,0 +1,191 @@
+require_relative '../../features_helper'
+
+describe 'application generated with shoestrap new <application_name>' do
+  before :all do
+    generate_test_app_with_shoestrap
+  end
+
+  it 'has timezone set for switzerland' do
+    expect(application_file('config/application.rb')).to match(/config.time_zone = 'Bern'/)
+  end
+
+  it 'has :de as default locale' do
+    expect(application_file('config/application.rb')).to match(/config.i18n.default_locale = :de/)
+  end
+
+  it 'has :de as only available locale for a satrt' do
+    expect(application_file('config/application.rb')).to match(/config.i18n.available_locales = \[:de\]/)
+  end
+
+  it 'has translation files load path' do
+    expect(application_file('config/application.rb')).to match(/config.i18n.load_path \+= Dir\[Rails.root.join\('config', 'locales', '\*\*', '\*.{rb,yml}'\).to_s\]/)
+  end
+
+  it 'has rspec-rails in the Gemfile' do
+    expect(application_file('Gemfile')).to match(/gem "rspec-rails"/)
+  end
+
+  it 'has guard-rspec in the Gemfile' do
+    expect(application_file('Gemfile')).to match(/gem "guard-rspec"/)
+  end
+
+  # TODO: fix this in rails. Gems added with gem method of app template have double quotes!
+
+  %w[
+     simple_form
+     haml
+     haml-rails
+     simple-navigation
+     mail
+     fabrication
+     shoestrap
+     kuhsaft
+     pry
+     ruby_gntp
+     database_cleaner
+     selectivizr-rails
+     modernizr-rails
+     bourbon
+  ].each do |gem_name|
+    it "has #{gem_name} in the Gemfile" do
+      expect(application_file('Gemfile')).to match "gem \"#{gem_name}\""
+    end
+  end
+
+  it 'has pg in the Gemfile' do
+    expect(application_file('Gemfile')).to match "gem 'pg'"
+  end
+
+  context 'application layout' do
+    it 'has no application layout written in erb' do
+      expect { application_file('app/views/layouts/application.html.erb') }.to raise_error(Errno::ENOENT)
+    end
+
+    it 'has an application layout written in haml' do
+      expect(application_file('app/views/layouts/application.html.haml')).not_to be_nil
+    end
+
+    it 'sets the html lang' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match "%html.no-js{ lang: I18n.locale }"
+    end
+
+    it 'sets a page title' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match(/%title=\ content_for\?\(:title\)\ \?\ yield\(:title\)\ :\ 'Untitled'/)
+    end
+
+    it 'has meta tags' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match "%meta{ charset: 'utf-8' }"
+      expect(application_file('app/views/layouts/application.html.haml')).to match "%meta{ 'http-equiv' => 'X-UA-Compatible', content: 'IE=edge,chrome=1' }"
+      expect(application_file('app/views/layouts/application.html.haml')).to match "%meta{ name: 'keywords', content: '' }"
+      expect(application_file('app/views/layouts/application.html.haml')).to match "%meta{ name: 'description', content: '' }"
+      expect(application_file('app/views/layouts/application.html.haml')).to match "%meta{ name: 'viewport', content: 'width=device-width, initial-scale=1.0' }"
+      expect(application_file('app/views/layouts/application.html.haml')).to match "= csrf_meta_tags"
+    end
+
+    it 'has favicons' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match(/favicon_link_tag\('favicons\/favicon\-sc\-129x129\.png',\ rel:\ 'apple\-touch\-icon',\ type:\ 'image\/png'\)/)
+      expect(application_file('app/views/layouts/application.html.haml')).to match(/favicon_link_tag\('favicons\/favicon\-sc\-32x32\.png',\ rel:\ 'icon',\ type:\ 'image\/png'\)/)
+      expect(application_file('app/views/layouts/application.html.haml')).to match(/favicon_link_tag\('favicons\/favicon\-sc\-16x16\.ico'\)/)
+    end
+
+    it 'has typekit integration' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match(/javascript_include_tag\ '\/\/use\.typekit\.net\/XXXX\.js',\ :media\ =>\ 'all'/)
+      expect(application_file('app/views/layouts/application.html.haml')).to match(/try\{Typekit\.load\(\);\}catch\(e\)\{\}/)
+    end
+
+    it 'has an application stylehseet link' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match "= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true"
+    end
+
+    it 'has javascript links' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match "= javascript_include_tag 'modernizr', 'data-turbolinks-track' => true"
+      expect(application_file('app/views/layouts/application.html.haml')).to match "= javascript_include_tag 'application', 'data-turbolinks-track' => true"
+      expect(application_file('app/views/layouts/application.html.haml')).to match "= javascript_include_tag 'selectivizr'"
+    end
+
+    it 'has a body class helper included' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match "%body{ class: body_class }"
+    end
+
+    it 'renders the navigation' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match "= render_navigation"
+    end
+
+    it 'renders the content' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match "= yield"
+    end
+
+    it 'has google analytics integrated' do
+      expect(application_file('app/views/layouts/application.html.haml')).to match(/var\ _gaq=\[\['_setAccount','UA\-XXXXX\-X'\],\['_trackPageview'\],\['_trackPageLoadTime'\]\];/)
+      expect(application_file('app/views/layouts/application.html.haml')).to match(/\(function\(d,t\)\{var\ g=d\.createElement\(t\),s=d\.getElementsByTagName\(t\)\[0\];g\.async=1;/)
+      expect(application_file('app/views/layouts/application.html.haml')).to match(/g\.src=\('https:'==location\.protocol\?'\/\/ssl':'\/\/www'\)\+'\.google\-analytics\.com\/ga\.js';/)
+      expect(application_file('app/views/layouts/application.html.haml')).to match(/s\.parentNode\.insertBefore\(g,s\)\}\(document,'script'\)\);/)
+    end
+  end
+
+  context 'favicons' do
+    it 'has a favicon' do
+      expect(application_file('app/assets/images/favicons/favicon-sc-32x32.png')).not_to be_nil
+    end
+
+    it 'has a favicon for iDevices' do
+      expect(application_file('app/assets/images/favicons/favicon-sc-129x129.png')).not_to be_nil
+    end
+
+    it 'has a favicton for IE' do
+      expect(application_file('app/assets/images/favicons/favicon-sc-16x16.ico')).not_to be_nil
+    end
+  end
+
+  context 'application helper' do
+    it 'has an application layout written in haml' do
+      expect(application_file('app/helpers/application_helper.rb')).not_to be_nil
+    end
+
+    it 'has a body_class method' do
+      expect(application_file('app/helpers/application_helper.rb')).to match "def body_class"
+    end
+  end
+
+  context 'generators' do
+    it 'use haml as a template engine' do
+      expect(application_file('config/application.rb')).to match "g.template_engine :haml"
+    end
+
+    it 'use rspec as test framework' do
+      expect(application_file('config/application.rb')).to match "test_framework :rspec"
+    end
+
+    it 'do not generate stylesheets' do
+      expect(application_file('config/application.rb')).to match "g.stylesheets false"
+    end
+
+    it 'do not generate javascripts' do
+      expect(application_file('config/application.rb')).to match "g.javascripts false"
+    end
+
+    it 'do not generate assets' do
+      expect(application_file('config/application.rb')).to match "g.assets false"
+    end
+
+    it 'does not generate helpers' do
+      expect(application_file('config/application.rb')).to match "g.helper false"
+    end
+
+    it 'uses simple_form as form builder' do
+      expect(application_file('config/application.rb')).to match(/form_builder :simple_form/)
+    end
+
+    context 'mailcatcher' do
+      it 'is configured for development environment' do
+        expect(application_file('config/environments/development.rb')).to match(/config\.action_mailer\.delivery_method = :smtp/)
+        expect(application_file('config/environments/development.rb')).to match(/config\.action_mailer\.smtp_settings = { address: 'localhost', port: 1025 }/)
+      end
+
+      it 'is documented in the readme' do
+        pending "implement proper readme template"
+        expect(application_file('README.md')).to match(/This Application uses Mailcatcher/)
+      end
+    end
+  end
+end