emerson 0.1.0.pre.1 → 0.1.0.pre.2

data/.gitignore

@@ -1,24 +1,18 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/.bundle
+/.env
+/.gemset
+/.import
+/.rvmrc
+/.rspec
+/.sublime*
+/.yardoc
 
-.gemset
-.rspec
-.rvmrc
-.import/
-.sublime*
-.wiprc
+/doc/*
+/log/*.log
+/pkg/*
+/tmp/*
+
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log/*.log
+/spec/dummy/tmp/
+/spec/dummy/.sass-cache

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --protected --plugin yard-rails lib/**/*.rb - README.md LICENSE

data/Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in emerson.gemspec
 gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+gem 'jasminerice',
+  :git => 'git://github.com/coreyti/jasminerice.git'
+gem "jasminerice-runner"

data/Gemfile.lock

@@ -0,0 +1,177 @@
+GIT
+  remote: git://github.com/coreyti/jasminerice.git
+  revision: 37e379c271cef665d71f54d7dd035687d6377c7d
+  specs:
+    jasminerice (0.0.8)
+      coffee-rails
+      haml
+
+PATH
+  remote: .
+  specs:
+    emerson (0.1.0.pre.2)
+      jquery-rails
+      rails (>= 3.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.2)
+    arel (3.0.2)
+    backports (2.6.4)
+    builder (3.0.4)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.6)
+      ffi (~> 1.0, >= 1.0.6)
+    coffee-rails (3.2.2)
+      coffee-script (>= 2.2.0)
+      railties (~> 3.2.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.3.3)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    ffaker (1.15.0)
+    ffi (1.1.5)
+    haml (3.1.7)
+    hike (1.2.1)
+    i18n (0.6.1)
+    jasmine (1.2.1)
+      jasmine-core (>= 1.2.0)
+      rack (~> 1.0)
+      rspec (>= 1.3.1)
+      selenium-webdriver (>= 0.1.3)
+    jasmine-core (1.2.0)
+    jasminerice-runner (0.0.3)
+      capybara
+    journey (1.0.4)
+    jquery-rails (2.1.3)
+      railties (>= 3.1.0, < 5.0)
+      thor (~> 0.14)
+    json (1.7.5)
+    libwebsocket (0.1.5)
+      addressable
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    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.2)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    rspec-rails (2.11.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.11.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+    virtus (0.5.2)
+      backports (~> 2.6.1)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+    yard (0.8.3)
+    yard-rails (0.3.0)
+      yard
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  coffee-script
+  emerson!
+  ffaker
+  jasmine
+  jasminerice!
+  jasminerice-runner
+  jquery-rails
+  rspec-rails
+  sqlite3
+  virtus
+  yard
+  yard-rails

data/Rakefile

@@ -1,2 +1,19 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  exit 1
+end
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.rspec_opts = '--color --format progress'
+  t.verbose = false
+end
+
+desc 'Default: run specs'
+task :default => [:spec]

data/emerson.gemspec

@@ -1,19 +1,32 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/emerson/version', __FILE__)
+$:.push File.expand_path("../lib", __FILE__)
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Corey Innis"]
-  gem.email         = ["corey@coolerator.net"]
-  gem.description   = %q{transcendent views}
-  gem.summary       = %q{emerson believes in the inherent good in...}
-  gem.homepage      = "https://github.com/coreyti/emerson"
+require "emerson/version"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "emerson"
-  gem.require_paths = ["lib"]
-  gem.version       = Emerson::VERSION
+Gem::Specification.new do |s|
+  s.name          = "emerson"
+  s.version       = Emerson::VERSION
+  s.authors       = ["Corey Innis"]
+  s.email         = ["corey@coolerator.net"]
+  s.homepage      = "https://github.com/coreyti/emerson"
+  s.summary       = %q{transcendent views}
+  s.description   = %q{emerson believes in the inherent good in...}
 
-  gem.add_dependency "rails", "~> 3.2.0"
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_dependency "rails", ">= 3.2.0"
+  s.add_dependency "jquery-rails" # for now.
+
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "coffee-script"
+  s.add_development_dependency "ffaker"
+  s.add_development_dependency "jasmine"
+  s.add_development_dependency "jasminerice"
+  s.add_development_dependency "jasminerice-runner"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "virtus"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "yard-rails"
 end

data/lib/emerson.rb

@@ -1,8 +1,65 @@
 require "emerson/version"
-require "emerson/rails"
+require "emerson/engine"
 
 module Emerson
   autoload :Responder, 'emerson/responder'
   autoload :Response,  'emerson/response'
   autoload :Scope,     'emerson/scope'
+
+  # Hook for enabling a specific set of Emerson "features".
+  #
+  # @note The disabling arguments (`nil`, `false`) are included for
+  #   completeness. A better way to disable Emerson features would be to
+  #   **not** include `Emerson::Response` in your controller(s).
+  #
+  # @param value [Array, Symbol, false, nil] The list of features,
+  #   `:all` (default), `nil` or `false` (to disable completely).
+  mattr_accessor :features
+  @@features = :all
+
+  # Custom path for fixture files.
+  #
+  # @note This attribute **must** be set in order to use the included response
+  #   matchers. If RSpec fixtures are disabled, be sure to enable specifically
+  #   for Emerson.
+  #
+  # @param value [String] The path. Defaults to RSpec's `fixture_path`.
+  mattr_accessor :fixture_path
+  @@fixture_path = nil
+
+  mattr_accessor :response_config
+  @@response_config = {
+    :json_default => 'full'
+  }
+
+  # Default way to setup Emerson. For Rails, call from an initializer.
+  #
+  # @example in 'config/initializers/emerson.rb'
+  #   Emerson.setup do |config|
+  #     config.fixture_path = Rails.root.join('custom/path')
+  #   end
+  def self.setup
+    # environmental defaults:
+    if defined?(RSpec)
+      self.fixture_path ||= RSpec.configuration.fixture_path
+    end
+
+    yield self
+  end
+
+  # Helper to determine whether `Emerson::Responder` is enabled.
+  def self.responder_enabled?
+    self.feature_enabled?(:responder)
+  end
+
+  # Helper to determine whether `Emerson::Scope` is enabled.
+  def self.scope_enabled?
+    self.feature_enabled?(:scope)
+  end
+
+  private
+
+    def self.feature_enabled?(key)
+      self.features.present? && (self.features == :all || self.features.include?(key))
+    end
 end

data/lib/emerson/engine.rb

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

data/lib/emerson/matchers.rb

@@ -0,0 +1,5 @@
+if defined?(RSpec)
+  require 'emerson/matchers/integrations/rspec'
+else
+  require 'emerson/matchers/integrations/test_unit'
+end

data/lib/emerson/matchers/action_controller.rb

@@ -0,0 +1,30 @@
+# require 'emerson/matchers/action_controller/send_html_matcher'
+require 'emerson/matchers/action_controller/send_json_matcher'
+
+module Emerson
+  module Matchers
+    # By using the matchers you can quickly and easily create concise and
+    # easy to read test suites.
+    #
+    # This code segment:
+    #
+    #   describe UsersController, "on GET to show with a valid id" do
+    #     before(:each) do
+    #       get :show, :id => User.first.to_param
+    #     end
+    #
+    #     it { should assign_to(:user) }
+    #     it { should respond_with(:success) }
+    #     it { should render_template(:show) }
+    #     it { should not_set_the_flash) }
+    #
+    #     it "should do something else really cool" do
+    #       assigns[:user].id.should == 1
+    #     end
+    #   end
+    #
+    # Would produce 5 tests for the show action
+    module ActionController
+    end
+  end
+end

data/lib/emerson/matchers/action_controller/send_json_matcher.rb

@@ -0,0 +1,106 @@
+module Emerson
+  module Matchers
+    module ActionController
+      # Example:
+      #
+      #   expect(response).to send_json({ :key => 'value' })
+      #   expect(response).to send_json('path/to/fixture')
+      #
+      # Example fixture definitions:
+      #
+      #   # 'data-fixture.json'
+      #   {
+      #     "data" : {
+      #       "user" : 1
+      #     }
+      #   }
+      #
+      #   # 'view-fixture.json'
+      #   {
+      #     "view" : "<article class=\"user\"></article>"
+      #   }
+      #
+      #   # 'full-fixture.json' (will merge data & view)
+      #   {
+      #     "$extends" : ["data-fixture.json", "view-fixture.json"]
+      #   }
+      def send_json(expected)
+        SendJsonMatcher.new(expected, self)
+      end
+
+      class SendJsonMatcher
+        attr_reader :expected, :actual, :mode
+
+        def initialize(expected, context)
+          @context  = context
+          @expected = prepare(expected)
+        end
+
+        def description
+          ['send JSON:', @mode_description].join(' ')
+        end
+
+        def matches?(response)
+          @actual = JSON.parse(response.body)
+          actual == expected
+        end
+
+        def failure_message
+          msg = <<-MSG
+            Expected actual response:
+            #{'-' * 60}
+            #{JSON.pretty_generate(actual)}
+            to match:
+            #{'-' * 60}
+            #{JSON.pretty_generate(expected)}
+          MSG
+
+          msg.gsub(/^\s{12}/, '')
+        end
+
+        private
+
+          def filename(name)
+            "#{name.sub(/\.json\z/, '')}.json"
+          end
+
+          def fixture(name)
+            File.join(fixture_path, filename(name))
+          end
+
+          # TODO: allow Test::Unit definition
+          def fixture_path
+            # @_fixture_path ||= "#{Emerson.fixture_path || RSpec.configuration.fixture_path}/responses"
+            @_fixture_path ||= File.join(Emerson.fixture_path, 'responses')
+          end
+
+          def prepare(source)
+            result = begin
+              case source
+              when String
+                @mode_description = filename(source)
+                path = fixture(source)
+                File.exist?(path) ? JSON.parse(File.read(path)) : { :missing => path.to_s }
+              when Array, Hash
+                @mode_description = '(provided)'
+                JSON.parse(source.to_json)
+              else
+                raise ArgumentError.new('expected "JSON" should be a Hash, or a String lookup')
+              end
+            end
+
+            if result.is_a?(Hash) && result.keys.include?('$extends')
+              refs = [result.delete('$extends')].flatten
+
+              result = {}.tap do |hash|
+                refs.each { |ref| hash.merge!(prepare(ref)) }
+                hash.merge!(result)
+              end
+            end
+
+            result
+          end
+      end
+    end
+  end
+end