hashrocket-rails 0.0.2 → 0.0.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Hashrocket Workstation
+Copyright (c) 2011 Hashrocket
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,13 @@
-# Hashrocket::Rails
+# Hashrocket on Rails
 
-TODO: Write a gem description
+Automate setting up a new project with defaults used at Hashrocket.
+
+This gem provides the following:
+
+  * Loose dependencies on gems we always use
+  * Common assets accessible via the asset pipeline
+  * A generator that sets up a base layout & sass structure
+  * An engine & generator that exposes UI comps
 
 ## Installation
 
@@ -18,10 +25,82 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Gem Dependencies
+
+There are a few gems we use on every project. These have been added to the
+gemspec without a version specified. It should be safe to exclude them from the
+project Gemfile. If you need to lock a specific version of the gem, just add it
+back to the project Gemfile.
+
+Included gems are:
+
+  * haml-rails
+  * decent_exposure
+
+### Generators
+
+Run all included generators:
+
+    $ rails g hashrocket:install
+
+This runs a meta generator which invokes the following:
+
+    $ rails g hashrocket:layout
+    $ rails g hashrocket:ui
+
+### Layout
+
+The generator adds a barebones haml layout and sets up the stylesheet structure for the app.
+
+Layout includes:
+
+  * html5shiv
+  * flash rendering
+  * a yield for head content
+
+Stylesheet structure:
+
+  * whitespace-reset is included
+  * requires all stylesheets in /vendor
+  * requires all stylesheets in /global
+  * does not automatically include root stylesheets
+  * imports mixins
+
+All assets required are included with the engine. You can work in the
+application stylesheet out of the box.
+
+### UI Boilerplate
+
+At Hashrocket we expose a `/ui` route where our front-end team implements
+design before it is integrated to the main app. This code is included as an
+engine. There is a generator which will hook your app into the engine.
+
+    $ rails g hashrocket:ui
+
+This will add a route and controller `app/controllers/ui_controller.rb` which
+subclasses the engine controller. This avoids the need to namespace UI files
+and provides an extension point for customization.
+
+You can now add UI comps to `app/views/ui` and they will appear at `/ui` in
+your app.
+
+You can explicitly exclude files from being shown in the UI index by adding the
+following to `ui_controller.rb`.
+
+    class UiController < Hashrocket::UiController
+      exclude 'filename', 'other_filename', ->(w) { w.ends_with?('_old') }
+    end
+
+By default the `index` view & any partials are excluded.
 
 ## Contributing
 
+The intention of this gem is to be included & used on every Hashrocket project.
+As such new features need to be something we might need on every project. Pull
+requests adding features specific to your workflow will likely be declined.
+
+However, if you think we are missing something feel free to make a case for it!
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)

data/app/assets/stylesheets/mixins.sass

@@ -0,0 +1,76 @@
+= border-radius($radius)
+  -moz-border-radius: $radius
+  border-radius: $radius
+
+= border-top-right-radius($radius)
+  -moz-border-radius-topright: $radius
+  border-top-right-radius: $radius
+
+= border-top-left-radius($radius)
+  -moz-border-radius-topleft: $radius
+  border-top-left-radius: $radius
+
+= border-bottom-right-radius($radius)
+  -moz-border-radius-bottomright: $radius
+  border-bottom-right-radius: $radius
+
+= border-bottom-left-radius($radius)
+  -moz-border-radius-bottomleft: $radius
+  border-bottom-left-radius: $radius
+
+= box-shadow($arguments)
+  -webkit-box-shadow: $arguments
+  -moz-box-shadow: $arguments
+  box-shadow: $arguments
+
+= opacity($val)
+  opacity: $val
+  filter: alpha(opacity=$val*100)
+
+= gradient-bg($color1, $color2)
+  background-color: $color1
+  background-image: -moz-linear-gradient(100% 100% 90deg, $color2, $color1)
+  background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from($color1), to($color2))
+
+= image-replace($img, $type:png)
+  display: block
+  font-size: 1px
+  text-indent: -8685px
+  overflow: hidden
+  background: url(/assets/#{$img}.#{$type}) no-repeat
+
+= underline-hover
+  text-decoration: none
+  &:hover
+    text-decoration: underline
+
+= wrapper
+  position: relative
+  min-width: 900px
+  max-width: 1200px
+  padding: 0 30px
+  margin-left: auto
+  margin-right: auto
+
+= button-skeleton($from, $to)
+  display: block
+  font-weight: bold
+  text-decoration: none
+  cursor: pointer
+  color: #fff
+  +gradient-bg($from, $to)
+  border: none
+  border: 1px solid $to + #202020
+  border-top: 1px solid $to + #444
+  text-shadow: 0 1px 1px desaturate($to - #333, 10%)
+  overflow: visible
+  outline: 1px solid $to
+  &:hover
+    +gradient_bg(saturate($from + #111111, 5%), $to)
+  &:active
+    +gradient-bg($from - #222, $to)
+  &[disabled], &.disabled
+    +opacity(.7)
+    cursor: default
+    &:hover
+      +gradient-bg($from, $to)

data/lib/generators/hashrocket/generators.rb

@@ -16,6 +16,11 @@ module Hashrocket
 
     private
 
+    def gitkeep(directory)
+      empty_directory directory
+      create_file '%s/.gitkeep' % directory
+    end
+
     def commit(msg)
       git add: '-A'
       git commit: "-m '#{msg}'"

data/lib/generators/hashrocket/install/install_generator.rb

@@ -1,14 +1,5 @@
-require 'generators/hashrocket/generators'
-
 module Hashrocket
   class InstallGenerator < ::Rails::Generators::Base
-    include Generators
-
-    def convert_layout
-      template 'application.html.haml', 'app/views/layouts/application.html.haml'
-      remove_file 'app/views/layouts/application.html.erb'
-      commit 'Convert layout to haml'
-    end
-
+    invoke 'hashrocket:layout', 'hashrocket:ui'
   end
 end

data/lib/generators/hashrocket/layout/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Base application layout & stylesheet setup
+
+Example:
+    rails generate hashrocket:layout
+
+    Installs a base layout with:
+      * html5shiv
+      * shared flash partial
+
+    Install a base stylsheet with:
+      * a standard directory structure
+      * mixins imported
+      * whitespace-reset

data/lib/generators/hashrocket/layout/layout_generator.rb

@@ -0,0 +1,21 @@
+require 'generators/hashrocket/generators'
+
+module Hashrocket
+  class LayoutGenerator < ::Rails::Generators::Base
+    include Generators
+
+    def setup_layout
+      template 'application.html.haml', 'app/views/layouts/application.html.haml'
+      remove_file 'app/views/layouts/application.html.erb'
+      commit 'Setup base layout'
+    end
+
+    def setup_stylesheets
+      remove_file 'app/assets/stylesheets/application.css'
+      gitkeep 'app/assets/stylesheets/vendor'
+      gitkeep 'app/assets/stylesheets/global'
+      template 'application.css.sass', 'app/assets/stylesheets/application.css.sass'
+      commit 'Setup base stylesheets'
+    end
+  end
+end

data/lib/generators/hashrocket/layout/templates/application.css.sass

@@ -0,0 +1,6 @@
+//= require whitespace-reset
+//= require_tree ./vendor
+//= require_tree ./global
+//= require_self
+
+@import mixins

data/lib/generators/hashrocket/ui/ui_generator.rb

@@ -4,8 +4,9 @@ module Hashrocket
   class UiGenerator < ::Rails::Generators::Base
     include Generators
 
-    def copy_controller
+    def setup_ui
       template 'ui_controller.rb', 'app/controllers/ui_controller.rb'
+      gitkeep 'app/views/ui'
     end
 
     def add_route

data/lib/hashrocket-rails/version.rb

@@ -1,3 +1,3 @@
 module Hashrocket
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashrocket-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2011-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml-rails
-  requirement: &2152146480 !ruby/object:Gem::Requirement
+  requirement: &2151924760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152146480
+  version_requirements: *2151924760
 - !ruby/object:Gem::Dependency
   name: decent_exposure
-  requirement: &2152145440 !ruby/object:Gem::Requirement
+  requirement: &2151924180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +33,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152145440
+  version_requirements: *2151924180
 description: Rails engine & generators for bootstrapping a Hashrocket project
 email:
 - dev@hashrocket.com
@@ -49,6 +49,7 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/html5.js
+- app/assets/stylesheets/mixins.sass
 - app/assets/stylesheets/whitespace-reset.sass
 - app/controllers/hashrocket/ui_controller.rb
 - app/models/hashrocket/wireframe.rb
@@ -56,9 +57,11 @@ files:
 - app/views/hashrocket/ui/index.html.haml
 - hashrocket-rails.gemspec
 - lib/generators/hashrocket/generators.rb
-- lib/generators/hashrocket/install/USAGE
 - lib/generators/hashrocket/install/install_generator.rb
-- lib/generators/hashrocket/install/templates/application.html.haml
+- lib/generators/hashrocket/layout/USAGE
+- lib/generators/hashrocket/layout/layout_generator.rb
+- lib/generators/hashrocket/layout/templates/application.css.sass
+- lib/generators/hashrocket/layout/templates/application.html.haml
 - lib/generators/hashrocket/ui/USAGE
 - lib/generators/hashrocket/ui/templates/ui_controller.rb
 - lib/generators/hashrocket/ui/ui_generator.rb

data/lib/generators/hashrocket/install/USAGE

@@ -1,11 +0,0 @@
-Description:
-    Every project needs these
-
-Example:
-    rails generate hashrocket:install
-
-    Installs a base layout plus:
-
-      * whitespace-reset
-      * html5shiv
-      * shared flash partial