grape-entity 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b398596f88871f8170eb2a73142bfdc08ca91370
+  data.tar.gz: 32aec8564a0c5f46522ffae2ac6167083440b8b0
+SHA512:
+  metadata.gz: e6ced06ae9b0a8bada53aae31a4eba8d5a58b717797b72adc2953ed4431dc99b21e711b370f027b45c19ac1b27f312a1d1300e29da64964e2b7e70fbc1f3a96c
+  data.tar.gz: 58fb3f143bffa542f8a8cfe1ce3f19f1f924588a670697c1ae596e27a80dd28eefea8ee4a3031d4c7cf89eeea85f6fa7912bdf6400d29474c0273e358bf594f6

data/CHANGELOG.markdown

@@ -1,8 +1,21 @@
 Next Release
 ============
 * Your contribution here.
+* Fixed bug with to_json.
 
-0.1.0 (01/11/2013)
+0.3.0 (2013-03-29)
+==================
+
+* Adds `with_options` for block-level exposure setting
+* DSL instance.entity now optionally accepts options to instantiate on the entity
+* You can pass symbols to `:if` and `:unless` to simply check for truthiness/falsiness of the specified options key
+
+0.2.0 (2013-01-11)
+==================
+
+* Moved the namespace back to Grape::Entity to preserve compatibility with Grape (via @dblock).
+
+0.1.0 (2013-01-11)
 ==================
 
 * Initial Release

data/README.markdown

@@ -6,15 +6,13 @@
 
 This gem adds Entity support to API frameworks, such as [Grape](https://github.com/intridea/grape). Grape's Entity is an API focussed facade that sits on top of an object model.
 
-## Goals
+## What's New 
 
-Through my own use of Entities I have found them really useful but wished they could be reused in other situations. In the context of Grape I wish it was easier to test the Entity so that you could test them seperately from your API and isolate their behavior. Entities also have a deep connection with the model and they should know what parameters are required and (especially in the case of an ActiveRecord Model) they should know how to ask about validation.
+We are currently working on a set of "shoulda-style matchers" (sorry, RSpec only right now -- although they've been done in a way that can support test-unit in the future).
 
-The Entity is a simple Facade on top of the model to transform it into the object you want to expose on your API.
+[Grape Entity Matchers](https://github.com/agileanimal/grape-entity-matchers).
 
-There is probably something heavier than an Entity that exists as well. A way to get a model object back from the Entity.
-
-In this spirit I want to give Entities a life of their own.
+This is still a work in progress but worth checking out.
 
 ## Reusable Responses with Entities
 
@@ -35,7 +33,7 @@ array.
     * define a list of fields which will always be exposed
   * `expose SYMBOLS, HASH`
     * HASH keys include `:if`, `:unless`, `:proc`, `:as`, `:using`, `:format_with`, `:documentation`
-      * `:if` and `:unless` accept hashes (passed during runtime) or procs (arguments are object and options)
+      * `:if` and `:unless` accept hashes (passed during runtime), procs (arguments are object and options), or symbols (checks for presence of the specified key on the options hash)
   * `expose SYMBOL, { :format_with => :formatter }`
     * expose a value, formatting it first
     * `:format_with` can only be applied to one exposure at a time
@@ -196,4 +194,4 @@ MIT License. See LICENSE for details.
 
 ## Copyright
 
-Copyright (c) 2010-2012 Michael Bleigh, and Intridea, Inc.
+Copyright (c) 2010-2013 Michael Bleigh, and Intridea, Inc.

data/grape-entity.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Michael Bleigh"]
   s.email       = ["michael@intridea.com"]
-  s.homepage    = "https://github.com/agileanimal/grape-entity"
+  s.homepage    = "https://github.com/intridea/grape-entity"
   s.summary     = %q{A simple facade for managing the relationship between your model and API.}
   s.description = %q{Extracted from Grape, A Ruby framework for rapid API development with great conventions.}
   s.license     = "MIT"

data/lib/grape_entity/entity.rb

@@ -1,3 +1,5 @@
+require 'multi_json'
+
 module Grape
   # An Entity is a lightweight structure that allows you to easily
   # represent data from your application in a consistent and abstracted
@@ -90,8 +92,8 @@ module Grape
       end
 
       # Instantiates an entity version of this object.
-      def entity
-        self.class.entity_class.new(self)
+      def entity(options = {})
+        self.class.entity_class.new(self, options)
       end
     end
 
@@ -122,6 +124,7 @@ module Grape
     #   field, typically the value is a hash with two fields, type and desc.
     def self.expose(*args, &block)
       options = args.last.is_a?(Hash) ? args.pop : {}
+      options = (@block_options ||= []).inject({}){|final, step| final.merge!(step)}.merge(options)
 
       if args.size > 1
         raise ArgumentError, "You may not use the :as option on multi-attribute exposures." if options[:as]
@@ -137,6 +140,21 @@ module Grape
       end
     end
 
+    # Set options that will be applied to any exposures declared inside the block.
+    #
+    # @example Multi-exposure if
+    # 
+    #   class MyEntity < Grape::Entity
+    #     with_options :if => {:awesome => true} do
+    #       expose :awesome, :sweet
+    #     end
+    #   end
+    def self.with_options(options)
+      (@block_options ||= []).push(options)
+      yield
+      @block_options.pop
+    end
+
     # Returns a hash of exposures that have been declared for this Entity or ancestors. The keys
     # are symbolized references to methods on the containing object, the values are
     # the options that were passed into expose.
@@ -376,11 +394,13 @@ module Grape
       case if_condition
         when Hash; if_condition.each_pair{|k,v| return false if options[k.to_sym] != v }
         when Proc; return false unless if_condition.call(object, options)
+        when Symbol; return false unless options[if_condition]
       end
 
       case unless_condition
         when Hash; unless_condition.each_pair{|k,v| return false if options[k.to_sym] == v}
         when Proc; return false if unless_condition.call(object, options)
+        when Symbol; return false if options[unless_condition]
       end
 
       true

data/lib/grape_entity/version.rb

@@ -1,3 +1,3 @@
 module GrapeEntity
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/grape_entity/entity_spec.rb

@@ -105,6 +105,40 @@ describe Grape::Entity do
       end
     end
 
+    describe '.with_options' do
+      it 'should apply the options to all exposures inside' do
+        subject.class_eval do
+          with_options(:if => {:awesome => true}) do
+            expose :awesome_thing, :using => 'Awesome'
+          end
+        end
+
+        subject.exposures[:awesome_thing].should == {:if => {:awesome => true}, :using => 'Awesome'}
+      end
+
+      it 'should allow for nested .with_options' do
+        subject.class_eval do
+          with_options(:if => {:awesome => true}) do
+            with_options(:using => 'Something') do
+              expose :awesome_thing
+            end
+          end
+        end
+
+        subject.exposures[:awesome_thing].should == {:if => {:awesome => true}, :using => 'Something'}
+      end
+
+      it 'should allow for overrides' do
+        subject.class_eval do
+          with_options(:if => {:awesome => true}) do
+            expose :less_awesome_thing, :if => {:awesome => false}
+          end
+        end
+
+        subject.exposures[:less_awesome_thing].should == {:if => {:awesome => false}}
+      end
+    end
+
     describe '.represent' do
       it 'returns a single entity if called with one object' do
         subject.represent(Object.new).should be_kind_of(subject)
@@ -502,6 +536,24 @@ describe Grape::Entity do
         subject.send(:conditions_met?, exposure_options, :condition1 => true, :condition2 => true, :other => true).should be_true
       end
 
+      it 'looks for presence/truthiness if a symbol is passed' do
+        exposure_options = {:if => :condition1}
+
+        subject.send(:conditions_met?, exposure_options, {}).should be_false
+        subject.send(:conditions_met?, exposure_options, {:condition1 => true}).should be_true
+        subject.send(:conditions_met?, exposure_options, {:condition1 => false}).should be_false
+        subject.send(:conditions_met?, exposure_options, {:condition1 => nil}).should be_false
+      end
+
+      it 'looks for absence/falsiness if a symbol is passed' do
+        exposure_options = {:unless => :condition1}
+
+        subject.send(:conditions_met?, exposure_options, {}).should be_true
+        subject.send(:conditions_met?, exposure_options, {:condition1 => true}).should be_false
+        subject.send(:conditions_met?, exposure_options, {:condition1 => false}).should be_true
+        subject.send(:conditions_met?, exposure_options, {:condition1 => nil}).should be_true
+      end
+
       it 'only passes through proc :if exposure if it returns truthy value' do
         exposure_options = {:if => lambda{|_,opts| opts[:true]}}
 
@@ -571,6 +623,10 @@ describe Grape::Entity do
             it 'has an object of itself' do
               instance.entity.object.should == instance
             end
+
+            it 'should instantiate with options if provided' do
+              instance.entity(:awesome => true).options.should == {:awesome => true}
+            end
           end
         end
       end

metadata

@@ -1,126 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-13 00:00:00.000000000 Z
+date: 2013-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  name: activesupport
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+        version: 1.3.2
   type: :runtime
   prerelease: false
-  name: multi_json
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.3.2
-- !ruby/object:Gem::Dependency
+        version: '0'
   type: :development
   prerelease: false
-  name: rake
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: maruku
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   type: :development
   prerelease: false
-  name: maruku
   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'
-- !ruby/object:Gem::Dependency
   type: :development
   prerelease: false
-  name: yard
   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'
-- !ruby/object:Gem::Dependency
+        version: '2.9'
   type: :development
   prerelease: false
-  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.9'
-- !ruby/object:Gem::Dependency
+        version: '0'
   type: :development
   prerelease: false
-  name: bundler
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Extracted from Grape, A Ruby framework for rapid API development with
@@ -148,38 +133,29 @@ files:
 - lib/grape_entity/version.rb
 - spec/grape_entity/entity_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/agileanimal/grape-entity
+homepage: https://github.com/intridea/grape-entity
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -1479047909720369637
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -1479047909720369637
       version: '0'
 requirements: []
 rubyforge_project: grape-entity
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple facade for managing the relationship between your model and API.
-test_files:
-- spec/grape_entity/entity_spec.rb
-- spec/spec_helper.rb
+test_files: []
 has_rdoc: