brainstem 0.0.2

data/spec/brainstem/presenter_spec.rb

@@ -0,0 +1,252 @@
+require 'spec_helper'
+
+describe Brainstem::Presenter do
+  describe "class methods" do
+
+    describe "presents method" do
+      before do
+        @klass = Class.new(Brainstem::Presenter)
+      end
+
+      it "records itself as the presenter for the named class as a string" do
+        @klass.presents "String"
+        Brainstem.presenter_collection.for(String).should be_a(@klass)
+      end
+
+      it "records itself as the presenter for the given class" do
+        @klass.presents String
+        Brainstem.presenter_collection.for(String).should be_a(@klass)
+      end
+
+      it "records itself as the presenter for the named classes" do
+        @klass.presents String, Array
+        Brainstem.presenter_collection.for(String).should be_a(@klass)
+        Brainstem.presenter_collection.for(Array).should be_a(@klass)
+      end
+    end
+
+    describe "implicit namespacing" do
+      module V1
+        class SomePresenter < Brainstem::Presenter
+        end
+      end
+
+      it "uses the closest module name as the presenter namespace" do
+        V1::SomePresenter.presents String
+        Brainstem.presenter_collection(:v1).for(String).should be_a(V1::SomePresenter)
+      end
+
+      it "does not map namespaced presenters into the default namespace" do
+        V1::SomePresenter.presents String
+        Brainstem.presenter_collection.for(String).should be_nil
+      end
+    end
+
+    describe "helper method" do
+      before do
+        @klass = Class.new(Brainstem::Presenter) do
+          def call_helper
+            foo
+          end
+        end
+        @helper = Module.new do
+          def foo
+            "I work"
+          end
+        end
+      end
+
+      it "includes and extends the given module" do
+        lambda { @klass.new.call_helper }.should raise_error
+        @klass.helper @helper
+        @klass.new.call_helper.should == "I work"
+        @klass.foo.should == "I work"
+      end
+    end
+
+    describe "filter method" do
+      before do
+        @klass = Class.new(Brainstem::Presenter)
+      end
+
+      it "creates an entry in the filters class ivar" do
+        @klass.filter(:foo, :default => true) { 1 }
+        @klass.filters[:foo][0].should eq({:default => true})
+        @klass.filters[:foo][1].should be_a(Proc)
+      end
+
+      it "accepts names without blocks" do
+        @klass.filter(:foo)
+        @klass.filters[:foo][1].should be_nil
+      end
+    end
+
+    describe "search method" do
+      before do
+        @klass = Class.new(Brainstem::Presenter)
+      end
+
+      it "creates an entry in the search class ivar" do
+        @klass.search do end
+        @klass.search_block.should be_a(Proc)
+      end
+    end
+  end
+
+  describe "post_process hooks" do
+    describe "adding object ids as strings" do
+      before do
+        post_presenter = Class.new(Brainstem::Presenter) do
+          presents Post
+
+          def present(model)
+            {
+              :body => model.body,
+            }
+          end
+        end
+
+        @presenter = post_presenter.new
+        @post = Post.first
+      end
+
+      it "outputs the associated object's id and type" do
+        data = @presenter.present_and_post_process(@post)
+        data[:id].should eq(@post.id.to_s)
+        data[:body].should eq(@post.body)
+      end
+    end
+
+    describe "converting dates and times" do
+      it "should convert all Time-and-date-like objects to iso8601" do
+        class TimePresenter < Brainstem::Presenter
+          def present(model)
+            {
+              :time => Time.now,
+              :date => Date.new,
+              :recursion => {
+                  :time => Time.now,
+                  :something => [Time.now, :else],
+                  :foo => :bar
+              }
+            }
+          end
+        end
+
+        iso8601_time = /\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}[-+]\d{2}:\d{2}/
+        iso8601_date = /\d{4}-\d{2}-\d{2}/
+
+        struct = TimePresenter.new.present_and_post_process("something")
+        struct[:time].should =~ iso8601_time
+        struct[:date].should =~ iso8601_date
+        struct[:recursion][:time].should =~ iso8601_time
+        struct[:recursion][:something].first.should =~ iso8601_time
+        struct[:recursion][:something].last.should == :else
+        struct[:recursion][:foo].should == :bar
+      end
+    end
+
+    describe "outputting polymorphic associations" do
+      before do
+        some_presenter = Class.new(Brainstem::Presenter) do
+          presents Post
+
+          def present(model)
+            {
+              :body => model.body,
+              :subject => association(:subject),
+              :another_subject => association(:subject)
+            }
+          end
+        end
+
+        @presenter = some_presenter.new
+        @post = Post.first
+      end
+
+      it "outputs the associated object's id and type" do
+        data = @presenter.present_and_post_process(@post)
+        data[:subject_id].should eq(@post.subject_id.to_s)
+        data[:subject_type].should eq(@post.subject_type)
+      end
+
+      it "outputs custom names for an associated object's id and type" do
+        data = @presenter.present_and_post_process(@post)
+        data[:another_subject_id].should eq(@post.subject_id.to_s)
+        data[:another_subject_type].should eq(@post.subject_type)
+      end
+    end
+
+    describe "outputting associations" do
+      before do
+        some_presenter = Class.new(Brainstem::Presenter) do
+          presents Workspace
+
+          def present(model)
+            {
+                :updated_at                 => model.updated_at,
+                :tasks                      => association(:tasks),
+                :user                       => association(:user),
+                :something                  => association(:user),
+                :lead_user                  => association(:lead_user),
+                :lead_user_with_lambda      => association { model.user },
+                :synthetic                  => association(:synthetic)
+            }
+          end
+        end
+
+        @presenter = some_presenter.new
+        @workspace = Workspace.find_by_title "bob workspace 1"
+      end
+
+      it "should not convert or return non-included associations, but should return <association>_id for belongs_to relationships, plus all fields" do
+        json = @presenter.present_and_post_process(@workspace, [])
+        json.keys.should =~ [:id, :updated_at, :something_id, :user_id]
+      end
+
+      it "should convert requested has_many associations (includes) into the <association>_ids format" do
+        @workspace.tasks.length.should > 0
+        @presenter.present_and_post_process(@workspace, [:tasks])[:task_ids].should =~ @workspace.tasks.map(&:id).map(&:to_s)
+      end
+
+      it "should convert requested belongs_to and has_one associations into the <association>_id format when requested" do
+        @presenter.present_and_post_process(@workspace, [:user])[:user_id].should == @workspace.user.id.to_s
+      end
+
+      it "converts non-association models into <model>_id format when they are requested" do
+        @presenter.present_and_post_process(@workspace, [:lead_user])[:lead_user_id].should == @workspace.lead_user.id.to_s
+      end
+
+      it "handles associations provided with lambdas" do
+        @presenter.present_and_post_process(@workspace, [:lead_user_with_lambda])[:lead_user_with_lambda_id].should == @workspace.lead_user.id.to_s
+      end
+
+      it "should return <association>_id fields when the given association ids exist on the model whether it is requested or not" do
+        @presenter.present_and_post_process(@workspace, [:user])[:user_id].should == @workspace.user_id.to_s
+
+        json = @presenter.present_and_post_process(@workspace, [])
+        json.keys.should =~ [:user_id, :something_id, :id, :updated_at]
+        json[:user_id].should == @workspace.user_id.to_s
+        json[:something_id].should == @workspace.user_id.to_s
+      end
+
+      it "should return null, not empty string when ids are missing" do
+        @workspace.user = nil
+        @workspace.tasks = []
+        @presenter.present_and_post_process(@workspace, [:lead_user_with_lambda])[:lead_user_with_lambda_id].should == nil
+        @presenter.present_and_post_process(@workspace, [:user])[:user_id].should == nil
+        @presenter.present_and_post_process(@workspace, [:something])[:something_id].should == nil
+        @presenter.present_and_post_process(@workspace, [:tasks])[:task_ids].should == []
+      end
+
+      context "when the model has an <association>_id method but no column" do
+        it "does not include the <association>_id field" do
+          def @workspace.synthetic_id
+            raise "this explodes because it's not an association"
+          end
+          @presenter.present_and_post_process(@workspace, []).should_not have_key(:synthetic_id)
+        end
+      end
+    end
+  end
+end

data/spec/brainstem_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Brainstem do
+  describe "default_namespace attribute" do
+    it "can be set and read" do
+      Brainstem.default_namespace = "something"
+      Brainstem.default_namespace.should eq("something")
+    end
+
+    it "returns 'none' if unset" do
+      Brainstem.default_namespace.should eq("none")
+    end
+  end
+
+  describe "presenter collection method" do
+    it "returns an instance of PresenterCollection" do
+      Brainstem.presenter_collection.should be_a(Brainstem::PresenterCollection)
+    end
+
+    it "accepts a namespace" do
+      Brainstem.presenter_collection("v1").should be_a(Brainstem::PresenterCollection)
+      Brainstem.presenter_collection("v1").should_not eq(Brainstem.presenter_collection)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+require 'logger'
+require 'rr'
+require 'rspec'
+require 'sqlite3'
+
+require 'brainstem'
+require_relative 'spec_helpers/db'
+require_relative 'spec_helpers/cleanup'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+
+  config.before(:each) do
+    Brainstem.logger = Logger.new(StringIO.new)
+  end
+
+  config.after(:each) do
+    Brainstem.clear_collections!
+    Brainstem.default_namespace = nil
+  end
+end

data/spec/spec_helpers/cleanup.rb

@@ -0,0 +1,23 @@
+module Brainstem
+
+  def self.clear_collections!
+    presenter_collection.presenters.each do |klass, presenter|
+      presenter.clear_options!
+    end
+    @presenter_collection = {}
+  end
+
+  class Presenter
+    def self.clear_options!
+      @default_sort_order = nil
+      @filters = nil
+      @sort_orders = nil
+      @search_block = nil
+    end
+
+    def clear_options!
+      self.class.clear_options!
+    end
+  end
+
+end

data/spec/spec_helpers/db.rb

@@ -0,0 +1,79 @@
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, :force => true do |t|
+    t.string :username
+    t.timestamps
+  end
+
+  create_table :workspaces, :force => true do |t|
+    t.string :title
+    t.string :description
+    t.belongs_to :user
+    t.timestamps
+  end
+
+  create_table :tasks, :force => true do |t|
+    t.string :name
+    t.integer :parent_id
+    t.belongs_to :workspace
+    t.timestamps
+  end
+
+  create_table :posts, :force => true do |t|
+    t.string :body
+    t.integer :subject_id
+    t.string :subject_type
+    t.timestamps
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :workspaces
+end
+
+class Task < ActiveRecord::Base
+  belongs_to :workspace
+  has_many :sub_tasks, :foreign_key => :parent_id, :class_name => "Task"
+  has_many :posts
+
+  def tags
+    %w[some tags]
+  end
+end
+
+class Workspace < ActiveRecord::Base
+  belongs_to :user
+  has_many :tasks
+  has_many :posts
+
+  scope :owned_by, -> id { where(:user_id => id) }
+  scope :numeric_description, where(:description => ["1", "2", "3"])
+
+  def lead_user
+    user
+  end
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :subject, :polymorphic => true
+end
+
+User.create!(:id => 1, :username => "bob")
+User.create!(:id => 2, :username => "jane")
+
+Workspace.create!(:id => 1, :user_id => 1, :title => "bob workspace 1", :description => "a")
+Workspace.create!(:id => 2, :user_id => 1, :title => "bob workspace 2", :description => "1")
+Workspace.create!(:id => 3, :user_id => 1, :title => "bob workspace 3", :description => "b")
+Workspace.create!(:id => 4, :user_id => 1, :title => "bob workspace 4", :description => "2")
+Workspace.create!(:id => 5, :user_id => 2, :title => "jane workspace 1", :description => "c")
+Workspace.create!(:id => 6, :user_id => 2, :title => "jane workspace 2", :description => "3")
+
+Task.create!(:id => 1, :workspace_id => 1, :name => "Buy milk")
+Task.create!(:id => 2, :workspace_id => 1, :name => "Buy bananas")
+Task.create!(:id => 3, :workspace_id => 1, :parent_id => 2, :name => "Green preferred")
+Task.create!(:id => 4, :workspace_id => 1, :parent_id => 2, :name => "One bunch")
+
+Post.create!(:id => 1, :subject => Workspace.first, :body => "first post!")
+Post.create!(:id => 2, :subject => Task.first, :body => "this is important. get on it!")

data/spec/spec_helpers/presenters.rb

@@ -0,0 +1,39 @@
+class WorkspacePresenter < Brainstem::Presenter
+  def present(model)
+    {
+      :title        => model.title,
+      :description  => model.description,
+      :updated_at   => model.updated_at,
+      :tasks        => association(:tasks),
+      :lead_user    => association(:lead_user, :json_name => "users")
+    }
+  end
+end
+
+class TaskPresenter < Brainstem::Presenter
+  def present(model)
+    {
+      :name         => model.name,
+      :sub_tasks    => association(:sub_tasks),
+      :other_tasks  => association(:sub_tasks, :json_name => "other_tasks"),
+      :workspace    => association(:workspace)
+    }
+  end
+end
+
+class UserPresenter < Brainstem::Presenter
+  def present(model)
+    {
+      :username => model.username
+    }
+  end
+end
+  
+class PostPresenter < Brainstem::Presenter
+  def present(model)
+    {
+      :body => model.body,
+      :subject => association(:subject)
+    }
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: brainstem
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Sufyan Adam
+- André Arko
+- Andrew Cantino
+- Katlyn Daniluk
+- Reid Gillette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Brainstem allows you to create rich API presenters that know how to filter,
+  sort, and include associations.
+email:
+- dev@mavenlink.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- brainstem.gemspec
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- lib/brainstem/association_field.rb
+- lib/brainstem/controller_methods.rb
+- lib/brainstem/engine.rb
+- lib/brainstem/presenter.rb
+- lib/brainstem/presenter_collection.rb
+- lib/brainstem/time_classes.rb
+- lib/brainstem/version.rb
+- lib/brainstem.rb
+- LICENSE
+- Rakefile
+- README.md
+- spec/brainstem/controller_methods_spec.rb
+- spec/brainstem/presenter_collection_spec.rb
+- spec/brainstem/presenter_spec.rb
+- spec/brainstem_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helpers/cleanup.rb
+- spec/spec_helpers/db.rb
+- spec/spec_helpers/presenters.rb
+homepage: http://developer.mavenlink.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2131973950543043950
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2131973950543043950
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ActiveRecord presenters with a rich request API
+test_files:
+- spec/brainstem/controller_methods_spec.rb
+- spec/brainstem/presenter_collection_spec.rb
+- spec/brainstem/presenter_spec.rb
+- spec/brainstem_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helpers/cleanup.rb
+- spec/spec_helpers/db.rb
+- spec/spec_helpers/presenters.rb
+has_rdoc: