RubyGems - rails-styleguide - Versions diffs - 0.0.1 - Mend

rails-styleguide 0.0.1

Files changed (69) hide show

data/.gitignore +6 -0
data/Gemfile +14 -0
data/Gemfile.lock +153 -0
data/MIT-LICENSE +20 -0
data/README.md +24 -0
data/Rakefile +27 -0
data/VERSION +1 -0
data/app/assets/javascripts/kss.js +40 -0
data/app/assets/javascripts/styleguide.js +1 -0
data/app/assets/stylesheets/styleguide.css +140 -0
data/app/controllers/styleguide_controller.rb +10 -0
data/app/helpers/styleguide_helper.rb +11 -0
data/app/views/layouts/styleguide.html.erb +24 -0
data/app/views/styleguide/_block.html.erb +24 -0
data/app/views/styleguide/index.html.erb +13 -0
data/config/routes.rb +3 -0
data/lib/rails-styleguide.rb +3 -0
data/lib/styleguide.rb +5 -0
data/lib/styleguide/engine.rb +5 -0
data/lib/styleguide/version.rb +11 -0
data/rails-styleguide.gemspec +21 -0
data/spec/dummy/.gitignore +15 -0
data/spec/dummy/Gemfile +31 -0
data/spec/dummy/Gemfile.lock +117 -0
data/spec/dummy/README +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/images/rails.png +0 -0
data/spec/dummy/app/assets/javascripts/application.js +8 -0
data/spec/dummy/app/assets/stylesheets/application.css +7 -0
data/spec/dummy/app/assets/stylesheets/buttons.css +50 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/mailers/.gitkeep +0 -0
data/spec/dummy/app/models/.gitkeep +0 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +54 -0
data/spec/dummy/config/boot.rb +6 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +30 -0
data/spec/dummy/config/environments/production.rb +60 -0
data/spec/dummy/config/environments/test.rb +39 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +10 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +10 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +60 -0
data/spec/dummy/db/seeds.rb +7 -0
data/spec/dummy/doc/README_FOR_APP +2 -0
data/spec/dummy/lib/assets/.gitkeep +0 -0
data/spec/dummy/lib/tasks/.gitkeep +0 -0
data/spec/dummy/log/.gitkeep +0 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +26 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/public/index.html +241 -0
data/spec/dummy/public/robots.txt +5 -0
data/spec/dummy/script/rails +6 -0
data/spec/dummy/vendor/assets/stylesheets/.gitkeep +0 -0
data/spec/dummy/vendor/plugins/.gitkeep +0 -0
data/spec/integration/navigation_spec.rb +9 -0
data/spec/integration/styleguide_spec.rb +31 -0
data/spec/spec_helper.rb +33 -0
data/spec/styleguide_spec.rb +7 -0
metadata +173 -0

data/app/helpers/styleguide_helper.rb ADDED

@@ -0,0 +1,11 @@
+module StyleguideHelper
+  def styleguide_block section, &block
+    section = styleguide.section section
+    render :partial => 'styleguide/block', :locals => { :section => section, :example_html => capture(&block) }
+  end
+  def styleguide
+    @styleguide ||= Kss::Parser.new(File.join(Rails.root, Rails.application.paths["app/assets"], "stylesheets"))
+  end
+end

data/app/views/layouts/styleguide.html.erb ADDED

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>Styleguide Example</title>
+  <%= stylesheet_link_tag :application %>
+  <%= stylesheet_link_tag :styleguide %>
+  <%= javascript_include_tag :styleguide %>
+</head>
+<body>
+  <header>
+    Styleguide Example
+  </header>
+  <div id="wrapper">
+    <%= yield %>
+  </div><!-- /#wrapper -->
+</body>
+</html>

data/app/views/styleguide/_block.html.erb ADDED

@@ -0,0 +1,24 @@
+<div class="styleguide-example">
+  <h3><%= section.section %> <em><%= section.filename %></em></h3>
+  <div class="styleguide-description">
+    <p><%= section.description %></p>
+    <% if section.modifiers.any? %>
+      <ul class="styleguide-modifier">
+        <% section.modifiers.each do |modifier| %>
+          <li><strong><%= modifier.name %></strong> - <%= modifier.description %></li>
+        <% end %>
+      </ul>
+    <% end %>
+  </div>
+  <div class="styleguide-element">
+    <%= example_html %>
+  </div>
+  <% section.modifiers.each do |modifier| %>
+    <div class="styleguide-element styleguide-modifier">
+      <span class="styleguide-modifier-name"><%= modifier.name %></span>
+      <%= example_html.gsub('$modifier_class', " #{modifier.class_name}").html_safe %>
+    </div>
+  <% end %>
+</div>

data/app/views/styleguide/index.html.erb ADDED

@@ -0,0 +1,13 @@
+<%= styleguide_block  '1.1' do %>
+  <button class="$modifier_class">Example Button</button>
+<% end %>
+<p>This block above was created with a simple template call:</p>
+<pre><code>&lt;% styleguide_block  &#x27;1.1&#x27; do %&gt;
+  &lt;button class=&quot;$modifier_class&quot;&gt;Example Button&lt;/button&gt;
+&lt;% end %&gt;</code></pre>
+<p>
+Take a look at the source code to <%= link_to __FILE__, "file://#{__FILE__}" %> for more details. The goal
+  is to remove the pain from creating a styleguide — document your CSS, have
+  example HTML in your templates and automate as much as possible.
+</p>

data/config/routes.rb ADDED

@@ -0,0 +1,3 @@
+Styleguide::Engine.routes.draw do
+  root :to => "styleguide#index"
+end

data/lib/rails-styleguide.rb ADDED

@@ -0,0 +1,3 @@
+module RailsStyleguide
+  require 'styleguide'
+end

data/lib/styleguide.rb ADDED

@@ -0,0 +1,5 @@
+module Styleguide
+  require 'styleguide/version'
+  require 'styleguide/engine'
+  require 'kss'
+end

data/lib/styleguide/engine.rb ADDED

@@ -0,0 +1,5 @@
+module Styleguide
+  class Engine < Rails::Engine
+  end
+end

data/lib/styleguide/version.rb ADDED

@@ -0,0 +1,11 @@
+# -*- encoding : utf-8 -*-
+module Styleguide
+  unless Styleguide.const_defined? :VERSION
+    def self.version
+      @version ||= File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
+    end
+    VERSION = self.version
+  end
+end

data/rails-styleguide.gemspec ADDED

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'styleguide/version'
+Gem::Specification.new do |s|
+  s.name = "rails-styleguide"
+  s.summary = "Rails engine that implements the Knyle Style Sheets styleguide"
+  s.authors = ["Chris Beer"]
+  s.description = "Insert Styleguide description."
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  # s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.version = Styleguide.version
+  s.add_dependency "kss"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "rails", "~> 3.1.0"
+end

data/spec/dummy/.gitignore ADDED

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+# Ignore bundler config
+/.bundle
+# Ignore the default SQLite database.
+/db/*.sqlite3
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy/Gemfile ADDED

@@ -0,0 +1,31 @@
+source 'http://rubygems.org'
+gem 'rails', '3.1.2'
+# Bundle edge Rails instead:
+# gem 'rails',     :git => 'git://github.com/rails/rails.git'
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.1.5.rc.2'
+  gem 'coffee-rails', '~> 3.1.1'
+  gem 'uglifier', '>= 1.0.3'
+end
+gem "rails-styleguide", :path => '../..'
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+# Use unicorn as the web server
+# gem 'unicorn'
+# Deploy with Capistrano
+# gem 'capistrano'
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'

data/spec/dummy/Gemfile.lock ADDED

@@ -0,0 +1,117 @@
+PATH
+  remote: ../..
+  specs:
+    rails-styleguide (0.0.1)
+      kss
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.2)
+      actionpack (= 3.1.2)
+      mail (~> 2.3.0)
+    actionpack (3.1.2)
+      activemodel (= 3.1.2)
+      activesupport (= 3.1.2)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.0)
+    activemodel (3.1.2)
+      activesupport (= 3.1.2)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.2)
+      activemodel (= 3.1.2)
+      activesupport (= 3.1.2)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.2)
+      activemodel (= 3.1.2)
+      activesupport (= 3.1.2)
+    activesupport (3.1.2)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    coffee-rails (3.1.1)
+      coffee-script (>= 2.2.0)
+      railties (~> 3.1.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.1.3)
+    erubis (2.7.0)
+    execjs (1.2.11)
+      multi_json (~> 1.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    json (1.6.3)
+    kss (0.1.1)
+      sass (>= 3.1)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    polyglot (0.3.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.2)
+      actionmailer (= 3.1.2)
+      actionpack (= 3.1.2)
+      activerecord (= 3.1.2)
+      activeresource (= 3.1.2)
+      activesupport (= 3.1.2)
+      bundler (~> 1.0)
+      railties (= 3.1.2)
+    railties (3.1.2)
+      actionpack (= 3.1.2)
+      activesupport (= 3.1.2)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.11)
+      json (~> 1.4)
+    sass (3.1.11)
+    sass-rails (3.1.5)
+      actionpack (~> 3.1.0)
+      railties (~> 3.1.0)
+      sass (~> 3.1.10)
+      tilt (~> 1.3.2)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+    uglifier (1.1.0)
+      execjs (>= 0.3.0)
+      multi_json (>= 1.0.2)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  coffee-rails (~> 3.1.1)
+  rails (= 3.1.2)
+  rails-styleguide!
+  sass-rails (~> 3.1.5.rc.2)
+  uglifier (>= 1.0.3)

data/spec/dummy/README ADDED

@@ -0,0 +1,261 @@
+== Welcome to Rails
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+== Getting Started
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+== Debugging Rails
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+The result will be a message in your log file along the lines of:
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+== Debugger
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+...and even better, you can examine how your runtime objects actually work:
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+Finally, when you're ready to resume execution, you can enter "cont".
+== Console
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+To start the console, run <tt>rails console</tt> from the application
+directory.
+Options:
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+== dbconsole
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+== Description of Contents
+The default directory structure of a generated Ruby on Rails application:
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+app
+  Holds all the code that's specific to this particular application.
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+script
+  Helper scripts for automation and generation.
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.