scaffoldr 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWNlNjExOGQwMGRjM2MzZTg2ZjZiMmRlYjVlNTE5Y2U4YTlhNzQ4NA==
+  data.tar.gz: !binary |-
+    ZmJiMTk1ZWI1NTk1ZTYwNWRkZWQxY2MxZTE0ZjgyYjJkY2U4ODAxNw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    M2RkYjdhZGZkMTM2YzE1MmMwNzVkY2VmZGU3MGE1YjI0YzJkZDA1ZmVhMjIz
+    Mzg3ZjhiY2UxNjVkODNhZTdhODRmYmM2ZWJjY2ZkZDZjY2RhN2IxZDIyMTUx
+    YTMzMGFjNGZmNGU4MWJhOTczYmNjZTA2Y2JjYTQxMTk2YThlYjY=
+  data.tar.gz: !binary |-
+    Yzg4NDE0OTVhZDA1YzRlOGY2ODcyNjY4NjE1OGRhYzIyOWQ0M2Q0ODE1ODNi
+    ZTFkZTZhM2M1MTZlYWMxYjBjNzk3NTJkOTYwMjhhMmYwYzQ2ZjdkMmYyYzc5
+    YmFlMTkxZWMyMTk2ZTMyODY0ZTNiNWMzOTIxN2UzZmY1YmFkZDM=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# gem 'builder', '~> 3.0.0' # without this being first, and with this version, bundler goes into infinite loop.
+# gem "twitter-bootstrap-rails", '>= 2.2.8'
+gem "actionpack", '~> 3'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,99 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    hike (1.2.3)
+    httpauth (0.2.0)
+    i18n (0.6.4)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.8)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Farley Knight Consulting, LLC
+
+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,95 @@
+# scaffoldr
+
+Start your Rails 3.1+ application with some default layouts, styled by
+Twitter Bootstrap. The available layouts are the ones
+from [The Twitter Bootstrap documentation](http://getbootstrap.com/2.3.2/getting-started.html#examples).
+
+# Usage
+
+Add to your Gemfile:
+
+    gem 'scaffoldr', :git => 'git@github.com:EncomLabs/scaffoldr.git'
+    gem 'twitter-bootstrap-rails'
+
+Right now there is a bug where we can't add the
+twitter-bootstrap-rails gem as a dependency, due to bundler errors, so
+include that in your Gemfile as well.
+
+Run the twitter-bootstrap-rails `static` or `less` installation so
+that the Twitter Bootstrap stylesheets and javascript are included in
+your application manifest files. The below example installs the `static`
+version:
+
+    rails g bootstrap:install static
+
+Generate a bootstrap example layout for yourself. Either of the following will work:
+
+**Warning: This will remove and overwrite your application.html.erb/haml file.**
+
+    rails g bootstrap:layout:starter
+    rails g bootstrap:layout:basic
+    rails g bootstrap:layout:fluid
+    rails g bootstrap:layout:marketing_narrow
+    rails g bootstrap:layout:justified_nav
+
+The layouts are also available in HAML form:
+
+    rails g bootstrap:layout:starter --template-engine=haml
+
+# Examples
+
+## Starter
+
+![Starter](https://raw.github.com/EncomLabs/scaffoldr/master/images/Starter.png)
+
+## Basic
+
+![Basic](https://raw.github.com/EncomLabs/scaffoldr/master/images/Basic.png)
+
+## Fluid
+
+![Fluid](https://raw.github.com/EncomLabs/scaffoldr/master/images/Fluid.png)
+
+## Marketing Narrow
+
+![Marketing Narrow](https://raw.github.com/EncomLabs/scaffoldr/master/images/MarketingNarrow.png)
+
+## Justified Nav
+
+![Justified Nav](https://raw.github.com/EncomLabs/scaffoldr/master/images/JustifiedNav.png)
+
+# Development
+
+Here are the commands mikedll uses to exercise the code manually. First we presume a Rails application
+template, named `gemtest.rb`:
+
+    gem 'twitter-bootstrap-rails'
+    gem 'haml'
+    gem 'scaffoldr', '0.1.0', :path => '/home/USERHOMEDIRECTORY/work/scaffoldr'
+
+Then run these two commands to rapidly execute a full new app and
+scaffold action. The second assumes you're already in the target app
+directory, dino_dictionary. That is, *it assumes you are in the middle
+of a redeploy loop*. Below "dino dictionary" is used as the name of the app, but
+that's arbitrary of course.
+
+    rm -rf dino_dictionary; rails new dino_dictionary -m ~/PATH/TO/gemtest.rb 
+    cd ..; cd dino_dictionary; rails g bootstrap:install static; rails g bootstrap:layout:starter --template-engine=haml; rails s
+
+## Tips
+
+- Look at the rails generators from other gems such as simple_form to
+get an idea of how they work.
+
+- The command-line invocation is derived from
+the module namespacing, and directory structure, of where you place
+the generator file in the generators directory.
+
+# Contributors
+
+- [Mike De La Loza](http://www.mikedll.com)
+
+# Copyright
+
+Copyright (c) 2013 Encom Labs. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name        = "scaffoldr"
+  gem.homepage    = "http://encomlabs.github.io/scaffoldr/"
+  gem.license     = "MIT"
+  gem.summary     = %Q{Twitter Bootstrap scaffolding layouts to get your app started.}
+  gem.description = %Q{Create scaffolding layouts for your application quickly. }
+  gem.email       = "mikedll@mikedll.com"
+  gem.authors     = ["Farley Knight Consulting, LLC", "Mike De La Loza"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scaffoldr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/generators/bootstrap/layout/basic/USAGE

@@ -0,0 +1,6 @@
+
+To create the Basic example layout in your application, run:
+
+    rails generate bootstrap:layout:basic
+
+

data/lib/generators/bootstrap/layout/basic/basic_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/layout/generator_base'
+
+module Bootstrap
+  module Layout
+    module Generators
+      class BasicGenerator < Bootstrap::Layout::GeneratorBase
+        source_root File.expand_path('../../templates', __FILE__)
+        desc "Create basic scaffolding layout file."
+        def nav_second_tier; true; end;
+      end
+    end
+  end
+end

data/lib/generators/bootstrap/layout/fluid/USAGE

@@ -0,0 +1,6 @@
+
+To create the Starter example layout in your application, run:
+
+    rails generate bootstrap:layout:fluid
+
+

data/lib/generators/bootstrap/layout/fluid/fluid_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/layout/generator_base'
+
+module Bootstrap
+  module Layout
+    module Generators
+      class FluidGenerator < Bootstrap::Layout::GeneratorBase
+        source_root File.expand_path('../../templates', __FILE__)
+        desc "Create fluid scaffolding layout file."
+        def nav_second_tier; true; end
+      end
+    end
+  end
+end

data/lib/generators/bootstrap/layout/generator_base.rb

@@ -0,0 +1,38 @@
+module Bootstrap
+  module Layout
+    class GeneratorBase < Rails::Generators::Base
+
+      attr_accessor :style, :body, :app_name
+
+      class_option :template_engine
+
+      def nav_second_tier; false; end
+
+      def create_layout
+        # Heavily from twitter-bootstrap-rails
+        app           = ::Rails.application
+        self.app_name = app.class.to_s.split("::").first
+        layout_name   = self.class.name.chomp("Generator").demodulize.underscore
+        engine        = options[:template_engine] || :erb
+        context       = instance_eval('binding')
+        self.style    = ERB.new(::File.new(::File.expand_path(find_in_source_paths("#{layout_name}.css"))).read).result(context)
+        self.body     = ERB.new(::File.new(::File.expand_path(find_in_source_paths("#{layout_name}.html.#{engine}"))).read).result(context)
+
+        remove_file "app/views/layouts/application.html.erb"
+        remove_file "app/views/layouts/application.html.haml"
+
+        template "base.html.#{engine}", "app/views/layouts/application.html.#{engine}"
+        remove_file "public/index.html"
+        copy_file "_nav.html.#{engine}", "app/views/shared/_nav.html.#{engine}"
+        copy_file "_nav_second_tier.html.#{engine}", "app/views/shared/_nav_second_tier.html.#{engine}" if nav_second_tier
+        copy_file "home_controller.rb.erb", "app/controllers/home_controller.rb"
+        template "index.html.#{engine}",         "app/views/home/index.html.#{engine}"
+      end
+
+      def routes
+        route 'root :to => "home#index"'
+      end
+
+    end
+  end
+end

data/lib/generators/bootstrap/layout/justified_nav/USAGE

@@ -0,0 +1,6 @@
+
+To create the Starter example layout in your application, run:
+
+    rails generate bootstrap:layout:justified_nav
+
+

data/lib/generators/bootstrap/layout/justified_nav/justified_nav_generator.rb

@@ -0,0 +1,12 @@
+require 'generators/bootstrap/layout/generator_base'
+
+module Bootstrap
+  module Layout
+    module Generators
+      class JustifiedNavGenerator < Bootstrap::Layout::GeneratorBase
+        source_root File.expand_path('../../templates', __FILE__)
+        desc "Create justfied nav scaffolding layout file."
+      end
+    end
+  end
+end

data/lib/generators/bootstrap/layout/marketing_narrow/USAGE

@@ -0,0 +1,6 @@
+
+To create the Starter example layout in your application, run:
+
+    rails generate bootstrap:layout:marketing_narrow
+
+

data/lib/generators/bootstrap/layout/marketing_narrow/marketing_narrow_generator.rb

@@ -0,0 +1,12 @@
+require 'generators/bootstrap/layout/generator_base'
+
+module Bootstrap
+  module Layout
+    module Generators
+      class MarketingNarrowGenerator < Bootstrap::Layout::GeneratorBase
+        source_root File.expand_path('../../templates', __FILE__)
+        desc "Create marketing narrow scaffolding layout file."
+      end
+    end
+  end
+end