styleguide_rails 0.2.2 → 0.3.0

data/README.md

@@ -1,4 +1,4 @@
-![Logo](illustration/logo.png "Logo")
+<img src="illustration/logo.png" alt="Styleguide Rails Logo" align="right" />
 
 Adds a [living style
 guide](http://24ways.org/2011/front-end-style-guides/) to your Rails
@@ -32,7 +32,7 @@ Add this gem to your Rails Gemfile:
 
 Run `bundle`, and execute the styleguide generator:
 
-    $ rails generate styleguide:install
+    rails generate styleguide:install
 
 That's it, you're done, you have a styleguide available at
 `http://yourapp.com/styleguide`. If you visit that path you'll see there
@@ -44,12 +44,26 @@ is an example widget already created:
 
 To add a new widget, run
 
-    $ rails generate styleguide:widget NAME
+    rails generate styleguide:widget NAME
 
 which will create a partial in `app/views/styleguide/widgets` and it
 will appear in the style guide. These partials support templating
 languages like Haml if you have the gems installed.
 
+## Live Reloading
+
+Styleguide Rails can reload your browser whenever you change a CSS file
+or a widget. This instant feedback is helpful for adjusting the styles.
+To enable live reloading,
+
+* Install the [LiveReload](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en)
+  plugin for Google Chrome.
+* Add `gem 'guard'` to your `Gemfile`
+* Run `bundle`
+* Run `guard` in a new terminal window
+* Be sure you enable the LiveReload plugin in Chrome. Just click its
+  icon.
+
 ## Credits
 
 Thanks to project
@@ -61,8 +75,8 @@ idea for this gem.
 
 To overwrite an installation of an earlier version, run
 
-    $ bundle update --source styleguide_rails
-    $ rails generate styleguide:install -f
+    bundle update --source styleguide_rails
+    rails generate styleguide:install -f
 
 Don't worry, this will preserve any existing widgets.
 

data/lib/generators/styleguide/install/USAGE

@@ -1,4 +1,4 @@
 Created a /styleguide route in your app to preview CSS styles.
 
 To create a new widget in the guide, run
-$ rails generate styleguide:widget name_of_widget
+rails generate styleguide:widget name_of_widget

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

@@ -10,7 +10,7 @@ module Styleguide
       end
 
       def create_route
-        route "match 'styleguide' => 'styleguide#index' if Rails.env.development?"
+        route "get 'styleguide' => 'styleguide#index' if Rails.env.development?"
       end
 
       def create_views
@@ -34,8 +34,8 @@ module Styleguide
         copy_file '_example_elements.html', 'app/views/styleguide/widgets/_example_elements.html'
       end
 
-      def show_readme
-        readme('../USAGE')
+      def enable_guard_reloading
+        copy_file 'Guardfile', 'Guardfile'
       end
     end
   end

data/lib/generators/styleguide/install/templates/Guardfile

@@ -0,0 +1,5 @@
+guard 'livereload' do
+  watch(%r{app/views/styleguide/.+\.(erb|haml|slim|html)$})
+  watch(%r{public/.+\.css})
+  watch(%r{(app|vendor)(/assets/\w+/(.+\.css)).*}) { |m| "/assets/#{m[3]}" }
+end

data/lib/generators/styleguide/install/templates/styleguide.html.erb

@@ -4,7 +4,7 @@
     <title>Application Style Guide</title>
     <%= stylesheet_link_tag    "application", :media => "all" %>
     <%= javascript_include_tag "application" %>
-    <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0;">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
 
     <!-- Bypass asset pipeline to protect other pages -->
     <script src="/javascripts/styleguide.js" type="text/javascript"></script>

data/lib/generators/styleguide/widget/templates/widget.html.haml

@@ -0,0 +1 @@
+%p Your new widget

data/lib/generators/styleguide/widget/templates/widget.html.slim

@@ -0,0 +1 @@
+p Your new widget

data/lib/generators/styleguide/widget/widget_generator.rb

@@ -9,8 +9,14 @@ module Styleguide
       desc "Creates a widget in your styleguide"
 
       def create_widget
+        supported_template_engines = [:haml, :erb, :slim]
         destination_name = name.gsub(/-/, '_').parameterize(sep = '_')
-        copy_file 'widget.html.erb', "app/views/styleguide/widgets/_#{destination_name}.html.erb"
+        template_engine = Rails.configuration.generators.options[:rails][:template_engine]
+
+        # use erb if we don't have a template for the engine currently in use
+        template_engine = :erb if !supported_template_engines.include? template_engine
+
+        copy_file "widget.html.#{template_engine}", "app/views/styleguide/widgets/_#{destination_name}.html.#{template_engine}"
       end
     end
   end

data/lib/styleguide_rails/version.rb

@@ -1,3 +1,3 @@
 module StyleguideRails
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/styleguide_rails.gemspec

@@ -6,7 +6,7 @@ require 'styleguide_rails/version'
 Gem::Specification.new do |gem|
   gem.name          = "styleguide_rails"
   gem.version       = StyleguideRails::VERSION
-  gem.authors       = ["Joe Nelson", "Adam Braus"]
+  gem.author        = "Joe Nelson"
   gem.email         = ["cred+github@begriffs.com"]
   gem.description   = %q{Add living CSS styleguide to your Rails project}
   gem.summary       = %q{Generates a controller, route, and views for your styleguide}
@@ -18,4 +18,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "rails", ">= 3.0.0"
+  gem.add_dependency "rb-readline"
+  gem.add_dependency "guard-livereload", "~> 1.4.0"
 end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: styleguide_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
 - Joe Nelson
-- Adam Braus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-livereload
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 description: Add living CSS styleguide to your Rails project
 email:
 - cred+github@begriffs.com
@@ -44,6 +75,7 @@ files:
 - illustration/screenshot.png
 - lib/generators/styleguide/install/USAGE
 - lib/generators/styleguide/install/install_generator.rb
+- lib/generators/styleguide/install/templates/Guardfile
 - lib/generators/styleguide/install/templates/_example_elements.html
 - lib/generators/styleguide/install/templates/_widget.html.erb
 - lib/generators/styleguide/install/templates/_widget_link.html.erb
@@ -53,6 +85,8 @@ files:
 - lib/generators/styleguide/install/templates/styleguide.js
 - lib/generators/styleguide/install/templates/styleguide_controller.rb
 - lib/generators/styleguide/widget/templates/widget.html.erb
+- lib/generators/styleguide/widget/templates/widget.html.haml
+- lib/generators/styleguide/widget/templates/widget.html.slim
 - lib/generators/styleguide/widget/widget_generator.rb
 - lib/styleguide_rails.rb
 - lib/styleguide_rails/version.rb
@@ -71,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3210306506630378600
+      hash: -456976210801234736
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -80,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3210306506630378600
+      hash: -456976210801234736
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25