smurf-rails 0.0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,67 @@
+SMURF
+=====
+
+**S**calable, **M**odular, re**U**sable **R**ails **F**rontends
+
+![SMURF](https://github.com/railslove/smurf/raw/master/app/assets/images/smurf/smurf.png)
+
+[![Build Status](https://secure.travis-ci.org/railslove/smurf.png?branch=master)](http://travis-ci.org/railslove/smurf)
+
+The name and the philosophy of SMURF are heavily influenced by the [SMACSS](http://smacss.com) approach by Jonathan Snook ([@snookca](https://twitter.com/snookca)) which stands for Scalable Modular Architecture for CSS.
+
+
+# SMURF Philosophy
+
+These are the main goals behind SMURF:
+
+## Goal 1:  Conventions
+
+Analog to what [SMACSS](http://smacss.com) does for modular CSS we want to establish conventions for naming, structure, filenames of all modular frontend code.  There should be a specific partial, helper or similar for each frontend module and it should be immediately clear how it needs to be named and where the files should be put.
+
+This goal is achieved when it is completely clear where all the necessary parts of a frontend modul are located.
+
+
+## Goal 2:  Living Styleguide
+
+Based on the conventions from Goal 1 we are creating tools that parse our Rails projects and render anything that makes sense into a living styleguide.  This would include an overview of all the modules with their different submodules and states and hopefully also some JS interactions.  The two goals behind this would be **a)** to have a tool for something like **"visual unit testing"** and **b)** to have a **communication device** for any kind of **design work** within a project.
+
+As a first step our SMURF gem can already render a living stylguide of all the color variables in your Sass code.
+
+An example for a similar tool could be [kss-rails](https://github.com/dewski/kss-rails)
+
+## Goal 3: Developing modules in the browser
+
+Once we have a tool to easily render all our modules the next step is to add the ability to write/change/tweak them right within the browser.  This would have the advantage that you could open the module editor in different browsers to directly account for x-browser differences and you don't have to hit reload again to see the effect of your changes to the frontend code.  One could see it as an equivalent for vim+tmux+autotest for frontend development.
+
+(technology ideas: [voyage-editor](http://voyage-editor.herokuapp.com/), [cloud9](http://c9.io), [fivetastic](https://github.com/makevoid/fivetastic))
+
+
+# SMURF Gem
+
+Currently the gem can parse your Sass files and display all the color variables your are using in a nice styleguide.
+
+## Prerequisites
+
+* Rails >3.1
+* Sass
+* Haml
+
+## Installation
+
+Add this to your `Gemfile`, run `bundle install`:
+
+    gem 'smurf-rails'
+    
+Add an initializer to your Rails project in which you tell SMURF where it can find your Sass files:
+
+    # config/initializers/smurf.rb
+    Smurf.sass_directory = Rails.root.join('app', 'assets', 'stylesheets').to_s
+    
+Mount the SMURF gem in your routes:
+
+    # config/routes.rb
+    
+    mount Smurf::Engine => "/smurf"
+    
+Restart your server and you should be able to access the SMURF pages, e.g. `yourapp.com/smurf/styleguide/colors`
+

data/Rakefile

@@ -0,0 +1,46 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Smurf'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test
+
+# task :testing do
+#   parser = Smurf::TypographyParser.new
+#   parser.parse "/home/jk/projects/smurf/test/unit/sass/typography.sass"
+#   puts parser.typographies.inspect
+# end

data/app/assets/javascripts/smurf/application.js

@@ -0,0 +1 @@
+//= require jquery

data/app/assets/stylesheets/smurf/application.css.sass

@@ -0,0 +1,38 @@
+//= require_self
+
+$border-color: silver
+$padding: 10px
+
+html, body, ul, li, p
+  font-family: sans-serif
+  font-size: 13px
+
+strong
+  font-weight: bold
+
+.smurf-color-list
+  padding: 0
+  > li
+    list-style-type: none
+    float: left
+    width: 300px
+    min-height: 80px
+    border: 1px solid $border-color
+    padding: $padding
+    margin: $padding
+    > ul
+      padding: 0
+
+.smurf-color-var
+  list-style-type: none
+  overflow: hidden
+  margin-bottom: $padding
+  > .smurf-color-var--name
+    float: left
+  > .smurf-color-var--mappings
+    padding: 0
+    float: right
+    > li
+      text-align: right
+      list-style-type: none
+

data/app/controllers/smurf/application_controller.rb

@@ -0,0 +1,4 @@
+module Smurf
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/smurf/styleguide_controller.rb

@@ -0,0 +1,19 @@
+module Smurf
+  class StyleguideController < ApplicationController
+    def colors
+      @parser = Smurf::ColorVariableParser.new
+      @parser.parse
+    end
+
+    def partials
+    end
+
+    def helper
+    end
+
+    def typography
+      # @parser = Smurf::TypographyParser.new
+      # @parser.parse
+    end
+  end
+end

data/app/helpers/smurf/application_helper.rb

@@ -0,0 +1,4 @@
+module Smurf
+  module ApplicationHelper
+  end
+end

data/app/helpers/smurf/styleguide_helper.rb

@@ -0,0 +1,14 @@
+require "color/css"
+
+module Smurf
+  module StyleguideHelper
+
+    # returns well readable, high-contrast foreground color ("black" or "white") based on passed background_color
+    def foreground_color(background_color)
+      if color = Smurf::ColorVariableParser.parse_color(background_color)
+        return "black"  if color.brightness > 0.5
+      end
+      return "white"
+    end
+  end
+end

data/app/views/layouts/smurf/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Smurf</title>
+  <%= stylesheet_link_tag    "smurf/application", :media => "all" %>
+  <%= javascript_include_tag "smurf/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/smurf/styleguide/_color_var.html.haml

@@ -0,0 +1,11 @@
+%li.smurf-color-var
+  .smurf-color-var--name
+    %strong= color_var
+    %small= "(#{@parser.print_variable_usage_count_for(color_var)})"
+
+  -if @parser.variable_mappings[color_var]
+    %ul.smurf-color-var--mappings
+      -@parser.variable_mappings[color_var].each do |color_mapping|
+        %li
+          = color_mapping
+          %small= "(#{@parser.print_variable_usage_count_for(color_mapping)})"

data/app/views/smurf/styleguide/colors.html.haml

@@ -0,0 +1,10 @@
+-if @parser
+  %ul.smurf-color-list
+    -@parser.colors.each do |color|
+      -color_value = color[0]
+      -color_vars = color[1]
+      %li{style: "background-color: #{color[0]}; color: #{foreground_color(color[0])}"}
+        .smurf-html-color= color[0]
+        %ul
+          -color_vars.each do |color_var|
+            = render partial: "color_var", locals: {color_var: color_var}

data/app/views/smurf/styleguide/typography.html.haml

@@ -0,0 +1,6 @@
+:sass
+  @import "typography"
+  .typo1
+    +default-text()
+
+.typo1= "typo1"

data/config/routes.rb

@@ -0,0 +1,6 @@
+Smurf::Engine.routes.draw do
+  root :to => "styleguide#colors"
+
+  match "styleguide/colors" => "styleguide#colors"
+  match "styleguide/typography" => "styleguide#typography"
+end

data/lib/smurf.rb

@@ -0,0 +1,7 @@
+require "smurf/engine"
+require "smurf/color_variable_parser"
+#require "smurf/typography_parser"
+
+module Smurf
+  mattr_accessor :sass_directory, :typography_sass_file
+end

data/lib/smurf/color_variable_parser.rb

@@ -0,0 +1,71 @@
+require "color/css"
+require "sass"
+
+module Smurf
+  class ColorVariableParser
+    attr_accessor :colors, :variable_mappings, :variable_usage, :sass_directory
+
+    def initialize(sass_directory = Smurf.sass_directory)
+      @colors            = {}
+      @variable_mappings = {}
+      @variable_usage    = {}
+      @sass_directory    = sass_directory
+    end
+
+    def parse_sass_directory(directory = sass_directory)
+      Dir.glob("#{directory}/**/*").each do |file|
+        if file.end_with?(".sass", ".scss")
+          parse_sass_file(file)
+          parse_variable_usage(file)
+        end
+      end
+    end
+    alias_method :parse, :parse_sass_directory
+
+    # parses Sass file and returns hash with colors and variable_mappings (or false)
+    def parse_sass_file(file, options = {})
+      Sass::Engine.for_file(file, options).to_tree.children.each do | node |
+        if node.kind_of? Sass::Tree::VariableNode
+          variable_node_parts = node.to_scss.split(":")
+          variable_name       = variable_node_parts[0]
+          value               = variable_node_parts[1].gsub(";", "").strip
+
+          if color = Smurf::ColorVariableParser.parse_color(value)
+            (self.colors[color.html] ||= []) << variable_name
+
+          elsif value.start_with? "$"
+            (self.variable_mappings[value] ||= []) << variable_name
+
+          end
+        end
+      end
+    end
+
+    def parse_variable_usage(file)
+      grep_output = `grep -iG "\$" #{file}`
+      grep_output.each_line do |line|
+        matches = line.scan(/\$[\w-]*/)
+        matches.each do |match|
+          self.variable_usage[match] ||= 0
+          self.variable_usage[match] += 1
+        end
+      end
+    end
+
+    def print_variable_usage_count_for(color)
+      self.variable_usage[color] - 1  rescue 0
+    end
+
+    def self.parse_color(color)
+      return false  unless color.is_a? String
+      
+      if color.include? "#"
+        Color::RGB.from_html(color) rescue false
+      elsif Color::CSS[color]
+        Color::CSS[color]
+      else
+        false
+      end
+    end
+  end
+end

data/lib/smurf/engine.rb

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

data/lib/smurf/typography_parser.rb

@@ -0,0 +1,28 @@
+require "sass"
+
+module Smurf
+  class TypographyParser
+    attr_accessor :typographies, :typography_sass_file
+
+    def initialize(typography_sass_file = Smurf.typography_sass_file)
+      @typographies = {}
+      @typography_sass_file = typography_sass_file
+    end
+
+    def parse(options = {})
+      sass_tree = Sass::Engine.for_file(self.typography_sass_file, options).to_tree
+      sass_tree.children.each do | node |
+        if node.kind_of?(Sass::Tree::CommentNode) && is_typography_comment?(node)
+          parsed_comment = YAML.load node.value.join.gsub!("// ", "")
+          self.typographies[parsed_comment["styleguide_typography"]["mixin"]] = parsed_comment["styleguide_typography"]["params"]
+        end
+      end
+    end
+
+    private
+
+      def is_typography_comment?(comment_node)
+        comment_node.value.any? { |comment| comment.index("styleguide_typography") }
+      end
+  end
+end

data/lib/smurf/version.rb

@@ -0,0 +1,3 @@
+module Smurf
+  VERSION = "0.0.3"
+end

data/lib/tasks/smurf_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :smurf do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -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.