guidelines 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*_local
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1,12 @@
+rvm use --create --install ruby-1.8.7@styleguides
+
+if [[ -s "./styleguides.gems" ]]; then
+  if ! rvm gemset import styleguides.gems ; then
+    echo "ERROR: Unable to bootstrap the gems" >&2
+  fi
+fi
+
+# Bundle is available, non-custom config.
+if command -v bundle >/dev/null && ! grep -q BUNDLE_FROZEN .bundle/config 2>/dev/null ; then
+  bundle install
+fi

data/.wiprc

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+[[ -s ".wiprc_fn" ]]    && source ".wiprc_fn"
+[[ -s ".wiprc_local" ]] && source ".wiprc_local"
+
+mode="$1"
+
+fn_check=`type -t $mode`
+if [  "function" == "$fn_check" ] ; then
+  eval $mode
+else
+  echo "default mode"
+fi

data/.wiprc_fn

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# project bootstrap steps go here
+# bootstrap() {
+# }
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in guidelines.gemspec
+gemspec

data/README.md

@@ -0,0 +1,78 @@
+guidelines
+==============================================================================
+
+more to come, but it's basically (for now) a Rails engine for providing your
+application with style guide(line)s against which to build your views.
+
+...in which "view" is defined as:
+
+  * Rails templates
+  * Rails view-related controller logic (e.g., rendering html or json)
+  * DOM produced
+  * CSS presentation
+  * JS behavior
+  * Images/fonts/etc.
+
+
+Requirements
+------------------------------------------------------------------------------
+
+  * Rails
+  * nokogiri
+  * The ability to consider a "view" as incorporating all of the components
+    in the definition above and a desire to apply the same degree of
+    convention and attention-to-detail to views as to models/controllers/etc.
+
+
+Installation
+------------------------------------------------------------------------------
+
+    gem install guidelines
+
+
+Usage
+------------------------------------------------------------------------------
+
+Add examples to `app/views/guidelines`, in which nested folders are fine.
+
+e.g.,
+
+    # app/views/guidelines/users/show.html.erb
+    <%= guideline_for('users#show') do |guideline| %>
+      <%= guideline.example do |example| -%>
+        <style type="text/css" media="screen">
+          /*
+            apply page-/example-specific styles here. should be few, as we're
+            really testing that things look good based on our app-wide styles.
+          */
+
+          <%= example.selector %> > h1 {
+            font-weight : bold;
+          }
+        </style>
+
+        <article class="user" id="user_1">
+          <h1>user one</h1>
+        </article>
+      <%- end -%>
+    <%- end -%>
+
+
+TODO
+------------------------------------------------------------------------------
+
+plenty
+
+
+Contributors
+------------------------------------------------------------------------------
+
+  * Corey Innis <http://github.com/coreyti>  
+    Author
+
+Acknowledgments
+------------------------------------------------------------------------------
+
+  * The IfWeRanTheWorld team <http://ifwerantheworld.com/>  
+    for inspiring an exploration into better integration of design and
+    development processes (which this project aims to address... over time).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/controllers/guidelines_controller.rb

@@ -0,0 +1,25 @@
+class GuidelinesController < ApplicationController
+  caches_page :index, :show
+
+  def index
+    render(:index, :locals => { :list => list })
+  end
+
+  def show
+    render(item)
+  end
+
+  private
+
+    def basepath
+      @basepath ||= Rails.root.join('app', 'views', 'guidelines')
+    end
+
+    def item
+      @item ||= "guidelines/#{params[:id].to_s.downcase}"
+    end
+
+    def list
+      @list ||= Dir.glob(File.join(basepath, "**", "*.html.*")).map { |fullpath| fullpath.sub(/#{basepath}\//, '').sub(/\.html.+$/, '') }
+    end
+end

data/app/helpers/guidelines_helper.rb

@@ -0,0 +1,8 @@
+module GuidelinesHelper
+  def guideline_for(name, *args, &proc)
+    raise ArgumentError, "Missing block" unless block_given?
+
+    # options = args.extract_options!
+    raw(GuidelinesHelper::Builder.new(name, self, proc).to_s)
+  end
+end

data/app/helpers/guidelines_helper/builder.rb

@@ -0,0 +1,39 @@
+module GuidelinesHelper
+  class Builder
+    attr_reader :name, :template, :examples
+
+    def initialize(name, template, proc)
+      @name, @template, @proc = name, template, proc
+      @examples = []
+
+      proc.call(self)
+    end
+
+    def to_s
+      @examples.join("\n")
+    end
+
+    def example(&block)
+      @examples << decorate(template.capture(GuidelinesHelper::Example.new(example_id), &block)) ; nil
+    end
+
+    private
+
+      def decorate(html)
+        fragment = Nokogiri::HTML::DocumentFragment.parse(html)
+        fragment.css('*').each do |node|
+          node.set_attribute('data-guideline-example', example_id)
+        end
+
+        fragment.to_html
+      end
+
+      def example_id
+        (@examples.length + 1).to_s
+      end
+
+      def safe_name
+        name.gsub(/[#\/]/, '_')
+      end
+  end
+end

data/app/helpers/guidelines_helper/example.rb

@@ -0,0 +1,13 @@
+module GuidelinesHelper
+  class Example
+    attr_reader :example_id
+
+    def initialize(example_id)
+      @example_id = example_id
+    end
+
+    def selector
+      "[data-guideline-example='#{example_id}']"
+    end
+  end
+end

data/app/views/guidelines/index.html.erb

@@ -0,0 +1,7 @@
+<h1><%= t('.heading') %></h1>
+
+<ul>
+  <%- list.each do |item| -%>
+  <li><%= link_to(item, guideline_path(item)) %></li>
+  <%- end -%>
+</ul>

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  guidelines:
+    index:
+      heading: 'Guidelines'

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  constraints(:id => /(\w|[\/_-])+/) do
+    resources :guidelines, :only => [:index, :show]
+  end
+end

data/guidelines.gems

@@ -0,0 +1,2 @@
+bundler -v 1.0.10
+wip     -v 0.2.0

data/guidelines.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "guidelines/version"
+
+Gem::Specification.new do |s|
+  s.name        = "guidelines"
+  s.version     = Guidelines::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Corey Innis"]
+  s.email       = ["corey@coolerator.net"]
+  s.homepage    = ""
+  s.summary     = %q{Adds guidelines to a Rails application.}
+  s.description = %q{To use guidelines in your application, simply add views in app/views/guidelines (nested paths are allowed).}
+
+  s.rubyforge_project = "guidelines"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/guidelines.rb

@@ -0,0 +1,7 @@
+require 'nokogiri'
+require 'guidelines/rails'
+
+module Guidelines
+
+end
+

data/lib/guidelines/rails.rb

@@ -0,0 +1,7 @@
+require 'guidelines/rails/engine'
+
+module Guidelines
+  module Rails
+    
+  end
+end

data/lib/guidelines/rails/engine.rb

@@ -0,0 +1,7 @@
+module Guidelines
+  module Rails
+    class Engine < ::Rails::Engine
+      
+    end
+  end
+end

data/lib/guidelines/version.rb

@@ -0,0 +1,3 @@
+module Guidelines
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: guidelines
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Corey Innis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-06 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: To use guidelines in your application, simply add views in app/views/guidelines (nested paths are allowed).
+email: 
+- corey@coolerator.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- .wiprc
+- .wiprc_fn
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/guidelines_controller.rb
+- app/helpers/guidelines_helper.rb
+- app/helpers/guidelines_helper/builder.rb
+- app/helpers/guidelines_helper/example.rb
+- app/views/guidelines/index.html.erb
+- config/locales/en.yml
+- config/routes.rb
+- guidelines.gems
+- guidelines.gemspec
+- lib/guidelines.rb
+- lib/guidelines/rails.rb
+- lib/guidelines/rails/engine.rb
+- lib/guidelines/version.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: guidelines
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Adds guidelines to a Rails application.
+test_files: []
+