daylight 0.9.0.rc1

data/spec/rails/daylight/api_controller_spec.rb

@@ -0,0 +1,421 @@
+require 'spec_helper'
+
+class Suite < ActiveRecord::Base
+  has_many :cases
+
+  def odd_cases
+    # computational results used by `remoted`
+    cases.select {|c| c.id.odd? }
+  end
+end
+
+class SuitesController < Daylight::APIController
+  handles :all
+
+  private
+    def suite_params
+      params.require(:suite).permit(:name, :switch)
+    end
+end
+
+class Case < ActiveRecord::Base
+  belongs_to :suite
+end
+
+# defined second to prove `handles :all` in SuitesController doesn't
+# publicize every subclass.
+class TestCasesController < Daylight::APIController
+  handles :create, :update, :destroy
+
+  self.model_name      = :case
+  self.record_name     = :result
+  self.collection_name = :results
+end
+
+class TestAppRecord < ActiveResource::Base
+end
+
+class TestErrorsController < Daylight::APIController
+  self.model_name  = :test_app_record
+
+  def raise_argument_error
+    raise ArgumentError.new('this is my message')
+  end
+
+  def raise_record_invalid_error
+    record = TestAppRecord.new
+    record.errors.add 'foo', 'error one'
+    record.errors.add 'bar', 'error two'
+    raise ActiveRecord::RecordInvalid.new(record)
+  end
+end
+
+describe Daylight::APIController, type: :controller do
+  migrate do
+    create_table :suites do |t|
+      t.boolean :switch
+      t.string  :name
+    end
+
+    create_table :cases, id: false do |t|
+      t.primary_key :test_id
+      t.integer     :suite_id
+      t.string      :name
+    end
+  end
+
+  before :all do
+    FactoryGirl.define do
+      factory :suite do
+        name   { Faker::Name.name }
+        switch false
+
+        after(:create) do |suite|
+          create_list :case,  3, suite: suite
+        end
+      end
+
+      factory :case do
+        name { Faker::Name.name }
+      end
+    end
+  end
+
+  after :all do
+    Rails.application.reload_routes!
+  end
+
+  describe "rescues errors" do
+    # rspec-rails does not honor the tests(controller) function
+    def self.controller_class
+     TestErrorsController
+    end
+
+    before do
+      @routes.draw do
+        get '/test_errors/raise_argument_error'
+        get '/test_errors/raise_record_invalid_error'
+      end
+    end
+
+    describe "rescue from ArgumentError" do
+      it "has status of bad_request" do
+        get :raise_argument_error
+
+        assert_response :bad_request
+      end
+
+      it "returns the error message as JSON" do
+        get :raise_argument_error
+
+        body = JSON.parse(response.body)
+        body['errors'].should == 'this is my message'
+      end
+    end
+
+    describe "rescue from RecordInvalid" do
+      it "has status of unprocessable_entity" do
+        get :raise_record_invalid_error
+
+        assert_response :unprocessable_entity
+      end
+
+      it "returns the record's errors as JSON" do
+        get :raise_record_invalid_error
+
+        body = JSON.parse(response.body)
+        body['errors'].count.should == 2
+        body['errors']['foo'].should == ['error one']
+        body['errors']['bar'].should == ['error two']
+      end
+    end
+
+    describe "rescue from UnpermittedParameters error" do
+      def self.controller_class
+        SuitesController
+      end
+
+      before do
+        @routes.draw do
+          resources :suites
+        end
+      end
+
+      it "has status of unprocessable_entity" do
+        post :create, suite: {unpermitted: 'attr'}
+
+        assert_response :unprocessable_entity
+      end
+
+      it "reports errors for unpermitted attributes" do
+        post :create, suite: {unpermitted: 'attr'}
+
+        body = JSON.parse(response.body)
+        body['errors']['unpermitted'].should == ['unpermitted parameter']
+      end
+    end
+
+    describe "rescue from ForbiddenAttributesError" do
+      def self.controller_class
+        TestCasesController
+      end
+
+      before do
+        @routes.draw do
+          resources :test_cases, only: [:create]
+        end
+      end
+
+      it "has status of unprocessable_entity" do
+        post :create, case: {suite_id: 0}
+
+        assert_response :bad_request
+      end
+
+      it "returns the record's errors as JSON" do
+        post :create, case: {name: 'unpermitted'}
+
+        assert_response :bad_request
+
+        body = JSON.parse(response.body)
+        body['errors'].should == 'parameters have not been permitted on this action'
+      end
+    end
+  end
+
+  describe "default configuration" do
+    let(:controller) { SuitesController }
+
+    it "uses controller name for record name" do
+      controller.record_name.should == 'suite'
+    end
+
+    it "uses controller name for model name" do
+      controller.model_name.should == 'suite'
+    end
+
+    it "uses 'collection' for collection name" do
+      controller.collection_name.should == 'collection'
+    end
+
+    it "uses controller name for model key" do
+      controller.send(:model_key).should == :suite
+    end
+
+    it 'determines model class' do
+      controller.send(:model).should == Suite
+    end
+
+    it 'delegates primary key to model class' do
+      controller.send(:primary_key).should == 'id'
+    end
+
+    it 'access record ivar' do
+      c = controller.new
+
+      c.send(:record=, 'foo')
+      c.send(:record).should == 'foo'
+      c.instance_variable_get('@suite').should == c.send(:record)
+    end
+
+    it 'access collection ivar' do
+      c = controller.new
+
+      c.send(:collection=, %w[foo bar])
+      c.send(:collection).should == %w[foo bar]
+      c.instance_variable_get('@collection').should == c.send(:collection)
+    end
+  end
+
+  describe "custom configuration" do
+    let(:controller) { TestCasesController }
+
+    it "overrides record name" do
+      controller.record_name.should == :result
+    end
+
+    it "overrides collection name" do
+      controller.collection_name.should == :results
+    end
+
+    it "overrides model name" do
+      controller.model_name.should == :case
+    end
+
+    it 'determines model key' do
+      controller.send(:model_key).should == :case
+    end
+
+    it 'determines model class' do
+      controller.send(:model).should == Case
+    end
+
+    it 'delegates primary key to determined model class' do
+      controller.send(:primary_key).should == 'test_id'
+    end
+
+    it 'access record ivar' do
+      c = controller.new
+
+      c.send(:record=, 'foo')
+      c.send(:record).should == 'foo'
+      c.instance_variable_get('@result').should == c.send(:record)
+    end
+
+    it 'access collection ivar' do
+      c = controller.new
+
+      c.send(:collection=, %w[foo bar])
+      c.send(:collection).should == %w[foo bar]
+      c.instance_variable_get('@results').should == c.send(:collection)
+    end
+  end
+
+  describe "API handling" do
+    let(:suites_controller) { SuitesController.new }     # handles :all
+    let(:cases_controller)  { TestCasesController.new }  # handles some
+    let(:errors_controller) { TestErrorsController.new } # handles none
+
+    it 'handles no API actions by default' do
+      Daylight::APIController::API_ACTIONS.each do |action|
+        errors_controller.should_not respond_to(action)
+      end
+    end
+
+    it 'handles some API actions but not others' do
+      allowed = [:create, :update, :destroy]
+      denied  = Daylight::APIController::API_ACTIONS.dup - allowed
+
+      allowed.each do |action|
+        cases_controller.should respond_to(action)
+      end
+
+      denied.each do |action|
+        cases_controller.should_not respond_to(action)
+      end
+    end
+
+    it 'handles all API actions' do
+      Daylight::APIController::API_ACTIONS.each do |action|
+        suites_controller.should respond_to(action)
+      end
+    end
+  end
+
+  describe "common actions" do
+    # rspec-rails does not honor the tests(controller) function
+    def self.controller_class
+      SuitesController
+    end
+
+    before do
+      @routes.draw do
+        resources :suites, associated: [:cases], remoted: [:odd_cases], controller: :suites
+      end
+    end
+
+    let!(:suite1) { create(:suite, switch: true)  }
+    let!(:suite2) { create(:suite, switch: false) }
+    let!(:suite3) { create(:suite, switch: true)  }
+
+    def parse_collection body, root='anonymous'
+      JSON.parse(body).values.first.
+        map(&:values).
+        map(&:first).
+        map(&:with_indifferent_access)
+    end
+
+    def parse_record body
+      JSON.parse(body).with_indifferent_access
+    end
+
+    it 'responds to index' do
+      get :index
+
+      results = parse_collection(response.body)
+      results.size.should == 3
+
+      names = results.map {|suite| suite["name"] }
+      names.should be_include(suite1.name)
+      names.should be_include(suite2.name)
+      names.should be_include(suite3.name)
+    end
+
+    it 'responds to index with refine_by' do
+      get :index, filters: {switch: true}
+
+      results = parse_collection(response.body)
+
+      results.size.should == 2
+      names = results.map {|suite| suite[:name] }
+      names.should be_include(suite1.name)
+      names.should be_include(suite3.name)
+    end
+
+    it 'creates a record' do
+      post :create, suite: suite = FactoryGirl.attributes_for(:suite)
+
+      result = parse_record(response.body)
+      result[:name].should   == suite[:name]
+      result[:switch].should == suite[:switch]
+
+      response.headers['Location'].should == "/suites/#{result['id']}"
+    end
+
+    it 'shows a record' do
+      post :show, id: suite2.id
+
+      result = parse_record(response.body)
+      result[:id].should     == suite2[:id]
+      result[:name].should   == suite2[:name]
+      result[:switch].should == suite2[:switch]
+    end
+
+    it 'updates a record' do
+      patch :update, id: suite3.id, suite: {name: 'Rik Mayall'}
+
+      Suite.find(suite3.id).name.should == 'Rik Mayall'
+    end
+
+    it 'deletes a record' do
+      delete :destroy, id: suite1.id
+
+      expect { Suite.find(suite1.id) }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+
+    it 'retrieves associated records' do
+      get :associated, id: suite1.id, associated: 'cases'
+
+      results = parse_collection(response.body)
+      results.size.should == 3
+
+      test_ids = results.map {|tc| tc['test_id'] }
+      test_ids.should be_include(suite1.cases[0].id)
+      test_ids.should be_include(suite1.cases[1].id)
+      test_ids.should be_include(suite1.cases[2].id)
+    end
+
+    it 'retrieves associated records with refine_by' do
+      get :associated, id: suite1.id, associated: 'cases', limit: 1
+
+      results = parse_collection(response.body)
+      results.size.should == 1
+
+      results.first['test_id'].should == suite1.cases.first.id
+    end
+
+    it 'retrieves remoted records' do
+      get :remoted, id: suite1.id, remoted: 'odd_cases'
+
+      results = parse_collection(response.body)
+      results.size.should == 2
+
+      odd_case_ids = suite1.odd_cases.map(&:test_id)
+
+      ids = results.map {|suite| suite["test_id"] }
+      ids.should be_include(odd_case_ids.first)
+      ids.should be_include(odd_case_ids.last)
+    end
+  end
+
+end

data/spec/rails/daylight/helpers_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Daylight::Helpers do
+  class HelperTestClass
+    include Daylight::Helpers
+
+    attr_accessor :params
+
+    def initialize params={}
+      @params = params
+    end
+  end
+
+  let(:helper) do
+    HelperTestClass.new(scopes: %w[scope_a scope_b], filters: {attr_a: 'Foo', attr_b: 'Bar'}, order: 'name ASC', limit: '10', offset: '100')
+  end
+
+  it 'returns refiner params' do
+    helper.scoped_params.should == %w[scope_a scope_b]
+  end
+
+  it 'returns filter params' do
+    helper.filter_params.should == {attr_a: 'Foo', attr_b: 'Bar'}
+  end
+
+  it 'returns order params' do
+    helper.order_params.should == 'name ASC'
+  end
+
+  it 'returns limit params' do
+    helper.limit_params.should == '10'
+  end
+
+  it 'returns offset params' do
+    helper.offset_params.should == 100
+  end
+
+  it 'raises an error if offset cannot be parsed as Integer' do
+    expect { HelperTestClass.new(offset: 'a').offset_params }.to raise_error(ArgumentError, %q[invalid value for Integer(): "a"])
+  end
+end

data/spec/rails/daylight/params_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Daylight::Params do
+
+  module HelperTest
+    def helper_method
+      params[:foo]
+    end
+  end
+
+  class ParamsTestClass
+    include Daylight::Params
+  end
+
+  let(:mixin) do
+    ParamsTestClass.new
+  end
+
+  it 'has no params method' do
+    mixin.should_not respond_to(:params)
+  end
+
+  describe :with_params do
+    it 'can access params directly' do
+      mixin.with_helper({foo: 'bar'}) do |helper|
+        helper.params[:foo].should == 'bar'
+      end
+    end
+
+    it 'can access params through helper methods' do
+      Daylight::Params::HelperProxy.send(:include, HelperTest)
+      mixin.with_helper({foo: 'baz'}) do |helper|
+        helper.helper_method.should == 'baz'
+      end
+    end
+
+    it 'still no params after accessed in context' do
+      mixin.with_helper({foo: 'bar'}) do |helper|
+        helper.params
+      end
+
+      mixin.should_not respond_to(:params)
+    end
+  end
+end

data/spec/rails/daylight/refiners_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+
+class RefinerMockActiveRecordBase
+  include Daylight::Refiners::Extension
+
+  def self.scope(name, body, &block); end
+  def self.where(*args); end
+  def self.order(*args); end
+  def self.reflections(*args); {} end
+end
+
+class RefinersTestClass < RefinerMockActiveRecordBase
+  scope :scope_a, -> { 'a' }
+  scope :scope_b, -> { 'b' }
+
+  def self.find(id)
+    RefinersTestClass.new
+  end
+
+  def foo
+    123
+  end
+end
+
+describe Daylight::Refiners::AttributeSeive do
+  let(:valid_attribute_names) { %w[foo bar baz] }
+
+  describe 'with invalid attributes' do
+    let(:seive) do
+      Daylight::Refiners::AttributeSeive.new(valid_attribute_names, %w[foo bar wibble])
+    end
+
+    it 'returns valid attributes' do
+      seive.valid_attributes.should == %w[foo bar]
+    end
+
+    it 'returns invalid attributes' do
+      seive.invalid_attributes.should == %w[wibble]
+    end
+
+    it 'returns false attributes_valid?' do
+      seive.should_not be_attributes_valid
+    end
+  end
+
+  it 'returns true when valid' do
+    seive = Daylight::Refiners::AttributeSeive.new(valid_attribute_names, %w[foo bar])
+    seive.should be_attributes_valid
+  end
+
+
+  it 'returns true when nil' do
+    seive = Daylight::Refiners::AttributeSeive.new(valid_attribute_names, nil)
+    seive.should be_attributes_valid
+  end
+end
+
+describe Daylight::Refiners do
+  it 'tracks registered scopes' do
+    RefinersTestClass.registered_scopes.should == %w[scope_a scope_b]
+  end
+
+  it 'returns true if scoped? finds a match' do
+    RefinersTestClass.should be_scoped(:scope_a)
+    RefinersTestClass.should_not be_scoped(:foo)
+  end
+
+  describe :scope_by do
+    let (:all) { double }
+
+    before do
+      RefinersTestClass.stub(all: all)
+    end
+
+    it 'raises an error an unknown scope is supplied' do
+      expect { RefinersTestClass.scoped_by(:foo) }.to raise_error(ArgumentError, 'Unknown scope: foo')
+    end
+
+    it 'applies supplied scope' do
+      all.should_receive(:scope_a)
+
+      RefinersTestClass.scoped_by(:scope_a)
+    end
+
+    it 'applies supplied scope' do
+      all.should_receive(:scope_a).and_return(all)
+      all.should_receive(:scope_b).and_return(all)
+
+      RefinersTestClass.scoped_by(%w[scope_a scope_b])
+    end
+
+    it 'applies no scope when nil is supplied' do
+      RefinersTestClass.scoped_by(nil).should == all
+    end
+  end
+
+  describe :filter_by do
+    before do
+      RefinersTestClass.stub(attribute_names: %w[foo bar])
+    end
+
+    it 'raises an error if an unknown attribute is supplied' do
+      expect { RefinersTestClass.filter_by(baz: 'wibble') }.to raise_error(ArgumentError, 'Unknown key: baz')
+    end
+
+    it 'applies where clause for all supplied attributes' do
+      RefinersTestClass.should_receive(:where).with({'foo' => 'baz', 'bar' => 'wibble'})
+
+      RefinersTestClass.filter_by({foo: 'baz', bar: 'wibble'})
+    end
+
+    it 'applies where clause with no attributes (and will be discarded by rails)' do
+      RefinersTestClass.should_receive(:where).with({})
+
+      RefinersTestClass.filter_by(nil)
+    end
+
+    it 'allows reflection keys' do
+      RefinersTestClass.stub(reflections: {boing: 'boing'})
+
+      expect { RefinersTestClass.filter_by(boing: 'boing') }.to_not raise_error
+    end
+  end
+
+  describe :order_by do
+    before do
+      RefinersTestClass.stub(attribute_names: %w[foo bar])
+    end
+
+    it 'raises an error if unknown attribute is supplied (as a String)' do
+      expect { RefinersTestClass.order_by('baz') }.to raise_error(ArgumentError, 'Unknown attribute: baz')
+      expect { RefinersTestClass.order_by('bar ASC, baz') }.to raise_error(ArgumentError, 'Unknown attribute: baz')
+      expect { RefinersTestClass.order_by('bar, baz ASC') }.to raise_error(ArgumentError, 'Unknown attribute: baz')
+      expect { RefinersTestClass.order_by('bar ASC, baz DESC') }.to raise_error(ArgumentError, 'Unknown attribute: baz')
+    end
+
+    it 'raises an error if unknown attribute is supplied (as an Array)' do
+      expect { RefinersTestClass.order_by([:baz, :foo]) }.to raise_error(ArgumentError, 'Unknown attribute: baz')
+    end
+
+    it 'raises an error if unknown attribute is supplied (as a Hash)' do
+      expect { RefinersTestClass.order_by({foo: 'asc', baz: 'asc', bar: 'desc'}) }.to raise_error(ArgumentError, 'Unknown attribute: baz')
+    end
+
+    it 'applies order clause for the supplied order' do
+      RefinersTestClass.should_receive(:order).with(nil)
+
+      RefinersTestClass.order_by(nil)
+    end
+  end
+
+  describe :remoted_methods do
+    before do
+      RefinersTestClass.add_remoted(:foo)
+    end
+
+    it "keeps track of remoted methods" do
+      RefinersTestClass.remoted?(:foo).should be_true
+      RefinersTestClass.remoted?(:not_a_remoted_method).should be_false
+
+      RefinersTestClass.remoted_methods.should == [:foo]
+    end
+
+    it "does not set up non-existent methods as remotes" do
+      RefinersTestClass.add_remoted(:unknown)
+      RefinersTestClass.remoted_methods.should_not include(:unknown)
+    end
+
+    it "raises an error if an unknown remoted is supplied" do
+      expect { RefinersTestClass.remoted(id:1, remoted:'not_a_remoted_method') }.to raise_error(ArgumentError)
+    end
+
+    it "returns the remoted call data" do
+      RefinersTestClass.remoted(id:1, remoted:'foo').should == 123
+    end
+  end
+end
+