cactus 0.2.0

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*.gem
+.bundle
+pkg/*
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use ruby-1.9.3-p125@cactus

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,121 @@
+PATH
+  remote: .
+  specs:
+    cactus (0.1.0)
+      jquery-rails (>= 2.0.1)
+      rails (>= 3.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.2)
+      actionpack (= 3.2.2)
+      mail (~> 2.4.0)
+    actionpack (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+    activerecord (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    ffi (1.0.11)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jasmine (1.1.2)
+      jasmine-core (>= 1.1.0)
+      rack (>= 1.1)
+      rspec (>= 1.3.1)
+      selenium-webdriver (>= 0.1.3)
+    jasmine-core (1.1.0)
+    journey (1.0.3)
+    jquery-rails (2.0.1)
+      railties (>= 3.2.0, < 5.0)
+      thor (~> 0.14)
+    json (1.6.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.1.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.2)
+      actionmailer (= 3.2.2)
+      actionpack (= 3.2.2)
+      activerecord (= 3.2.2)
+      activeresource (= 3.2.2)
+      activesupport (= 3.2.2)
+      bundler (~> 1.0)
+      railties (= 3.2.2)
+    railties (3.2.2)
+      actionpack (= 3.2.2)
+      activesupport (= 3.2.2)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    rubyzip (0.9.6.1)
+    selenium-webdriver (2.20.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      multi_json (~> 1.0)
+      rubyzip
+    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.32)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cactus!
+  jasmine
+  rspec

data/MIT.LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012
+
+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,131 @@
+# Cactus
+
+Designs can be tested too! Cactus is a CSS testing framework proof of concept.
+
+It ensures that you always have the same CSS styling for DOM elements that you care about.
+
+## Prerequisites
+
+- Ruby on Rails, 3.2.x
+- jquery-rails
+
+## Installation
+
+Install the Cactus gem manually or include it in your Rails Gemfile.
+
+    gem install cactus
+
+Add jQuery to application.js (or any manifest file)
+
+    //= require jquery
+
+Add the Cactus helper in your application layout, just before the `body` closing tag (assuming haml).
+
+    = cactus
+
+Finally, add some CSS specs (written in JavaScript) in `public/cactus_spec`. Files need to end with spec.js.
+
+    Cactus.expect(".header", "font-size").toEqual("24px");
+    Cactus.expect("p", "font-size").toEqual("12px");
+
+## A Brief Explanation
+
+The Cactus helper in your application layout includes Cactus.js and all spec files located in `public/cactus_spec/` on every page load in the Dev and Test env; the helper will not output anything when in other (Prod, Staging etc) environments.
+
+Once the files are included, the specs will be verified against the current page DOM, and results will be displayed.
+
+## Writing Specs
+
+Write your specs in JavaScript, and place them in the `public/cactus_spec/` folder.
+
+### Expectations
+
+You can make an expectation either on a specific element or a group of elements.
+
+#### `expect`
+
+    Cactus.expect(".header", "font-size").toEqual("24px");
+
+The `expect` method requires a tag name and an attribute. All elements that resolve to the tag name will be tested.
+
+### Matchers
+
+The expectations are chained to matchers for verification of CSS styling.
+
+#### `toEqual`
+
+    Cactus.expect(".header", "font-size").toEqual("24px");
+
+This tests for total equality.
+
+#### `toContain`
+
+    Cactus.expect(".header", "font-family").toContain("Helvetica");
+
+This tests for partial equality, using a REGEX constructed from the pass in value.
+
+#### `toHaveColor`
+
+    Cactus.expect(".header", "color").toEqual("#ff0000");
+
+This tests for total equality, by converting rgba values returned by browser into hex values.
+
+#### `toHaveMargin`
+
+    Cactus.expect(".header").toHaveMargin("10px");
+
+This tests equality on all sides of the element. You can pass in shorthand or longhand notation.
+
+#### `toHavePadding`
+
+    Cactus.expect(".header").toHaveMargin("10px 5px");
+
+This tests equality on all sides of the element. You can pass in shorthand or longhand notation.
+
+#### `toHaveBorderWidth`
+
+    Cactus.expect(".header").toHaveBorderWidth("1px");
+
+This tests equality on all sides of the element. You can pass in shorthand or longhand notation.
+
+#### `toHaveBorderColor`
+
+    Cactus.expect(".header").toHaveBorderColor("#ff000");
+
+This tests equality on all sides of the element.
+
+## Automating
+
+With RSpec and Capybara (Selenium webdriver), it's possible to automate the Cactus tests by writing request specs.
+
+Add the following RSpec matcher to `spec/spec_helper.rb`:
+
+    RSpec::Matchers.define :be_cactus do
+      match do |actual|
+        all(".cactus_fail").blank?
+      end
+
+      failure_message_for_should do |actual|
+        message = "Oei! Something is wrong with the CSS on '#{actual.current_url}' lah!\n"
+        all(".cactus_fail").each do |failure|
+          message += "- #{failure.text}\n"
+        end
+        message
+      end
+    end
+
+Write a request spec `spec/requests/cactus_spec.rb`
+
+    describe 'rspec and capybara integration with cactus', js: true do
+      it "is cactus-ready " do
+        page.should be_cactus
+      end
+    end
+
+## Maintainers
+- [Winston Teo](mailto: winston@newcontext.com), {new context}
+
+
+## License
+
+This software is licensed under the MIT License.

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks # Gives us rake build, rake install and rake release
+
+# RSpec Tasks
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--options', '.rspec']
+end
+
+task :default => :spec
+
+# Jasmine Tasks
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/cactus.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "cactus/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cactus"
+  s.version     = Cactus::VERSION
+  s.authors     = ["Winston Teo"]
+  s.email       = ["winston@newcontext.com"]
+  s.homepage    = "https://github.com/winston/cactus"
+  s.summary     = %q{Cactus is a CSS testing framework}
+  s.description = %q{Designs can be tested too. Cactus is a CSS testing framework. It ensures that you always have the same CSS styling for DOM elements that you care about.}
+
+  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"]
+
+  s.add_dependency "rails"        , ">= 3.2.0"
+  s.add_dependency "jquery-rails" , ">= 2.0.1"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "jasmine"
+end

data/ci_build.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# RVM
+source ~/.rvm/scripts/rvm && source .rvmrc
+
+# Install bundler 
+gem list --local bundler | grep bundler || gem install bundler || exit 1
+
+# Debugging Info
+echo USER=$USER && ruby --version && which ruby && which bundle
+
+# Install project gems from Gemfile
+bundle check || bundle install || exit 1
+
+# Test!
+bundle exec rake && bundle exec rake jasmine:ci

data/lib/cactus.rb

@@ -0,0 +1,5 @@
+require "cactus/version"
+
+# Rails Helper
+lib_path = File.dirname(__FILE__)
+require "#{lib_path}/cactus/rails/engine.rb" if defined?(Rails)

data/lib/cactus/rails/engine.rb

@@ -0,0 +1,13 @@
+require "#{File.dirname(__FILE__)}/helpers/view_helper"
+
+module Cactus
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer "cactus" do
+        ActiveSupport.on_load(:action_controller) do
+          include Cactus::Rails::ViewHelper
+        end
+      end
+    end
+  end
+end

data/lib/cactus/rails/helpers/view_helper.rb

@@ -0,0 +1,27 @@
+module Cactus
+  module Rails
+    module ViewHelper
+      extend  ActiveSupport::Concern
+
+      included do
+        helper_method "cactus"
+      end
+
+      def cactus
+        return unless ::Rails.env.test? || ::Rails.env.development?
+
+        html  = "<script src='/assets/cactus.js' type='text/javascript'></script>"
+
+        dir   = "#{::Rails.root}/public"
+        specs = Dir[File.join(dir, "/cactus_spec", "/*spec.js")]
+        specs.each do |file|
+          filename = file[-(file.size - dir.size)..-1]
+
+          html += "<script src='#{filename}' type='text/javascript'></script>"
+        end
+
+        html.html_safe
+      end
+    end
+  end
+end

data/lib/cactus/version.rb

@@ -0,0 +1,3 @@
+module Cactus
+  VERSION = "0.2.0"
+end

data/spec/cactus/rails/helpers/view_helper_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe ApplicationController do
+
+  describe "cactus" do
+    let(:controller) { ApplicationController.new }
+    let(:html)       { controller.cactus }
+
+    it "has method" do
+      ApplicationController.instance_methods.should include :cactus
+    end
+
+    it "includes method in corresponding helper" do
+      ApplicationController.helpers.methods.should  include :cactus
+    end
+
+    context "rendering" do
+      it "renders cactus.js" do
+        html.should =~ /cactus.js/i
+      end
+
+      it "renders *spec.js files located in public/cactus_spec" do
+        html.should_not =~ /spec\/dummy\/public/i
+
+        html.should =~ /cactus_spec\/css1_spec.js/i
+        html.should =~ /cactus_spec\/css2_spec.js/i
+
+        html.should_not =~ /notcss.js/i
+      end
+    end
+
+    context "environment" do
+      it "production renders nothing" do
+        ::Rails.should_receive(:env).any_number_of_times.and_return(ActiveSupport::StringInquirer.new("production"))
+        html.should be_blank
+      end
+
+      it "any other renders nothing" do
+        ::Rails.should_receive(:env).any_number_of_times.and_return(ActiveSupport::StringInquirer.new("staging"))
+        html.should be_blank
+      end
+
+      it "test renders something" do
+        ::Rails.should_receive(:env).any_number_of_times.and_return(ActiveSupport::StringInquirer.new("test"))
+        html.should_not be_blank
+      end
+
+      it "development renders something" do
+        ::Rails.should_receive(:env).any_number_of_times.and_return(ActiveSupport::StringInquirer.new("development"))
+        html.should_not be_blank
+      end
+    end
+  end
+
+end