representable-expandable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 237b0654dd7f31f1b8a6b0aa475606c1fce444cd
+  data.tar.gz: 2e7c929251b32166a6958914a08ae75d7f7bdc45
+SHA512:
+  metadata.gz: ec969453f9e3002aa252677f6104f0b98196ed7b203de3f379a96eb964f2acda0a70bb89b0d7b8ea15113a92786e01b39fde279760e4300599a9dd197301bde8
+  data.tar.gz: 965305b8f5c745ca598ec6e681ad636ed5602ed53ee3d5f350e14bdb4d2b1a420ee0a5f269dfffe8c2dc4473818c9fde7e192553d99c5a62dde1f5b7b317cb14

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.1.1

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+gemspec
+gem 'rake'
+
+gem 'rspec'
+gem 'representable'
+gem 'multi_json'

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    representable-expandable (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    declarative (0.0.5)
+      uber (>= 0.0.15)
+    diff-lcs (1.2.5)
+    multi_json (1.11.2)
+    rake (0.9.6)
+    representable (2.4.0)
+      declarative (~> 0.0.5)
+      uber (~> 0.0.15)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    uber (0.0.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  multi_json
+  rake
+  representable
+  representable-expandable!
+  rspec
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ashkan
+
+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,45 @@
+# Representable Expandable Extension [![Build Status](https://travis-ci.org/ashkan18/representable-expandable.svg?branch=master)](https://travis-ci.org/ashkan18/representable-expandable)
+
+This gem is an extension on top of [Representable](https://github.com/apotonick/representable) which allows us to by default exclude properties/collections from representables and explicitly include them by setting right option on Representable. 
+
+## Installation
+Add following line to your Gemfile
+
+```
+gem 'representable-expandable'
+```
+
+## Usage
+You can make a collection `Expandable` by includeing `Representable::Expandable` in your `Representable` and set `expandable: true` for your expandable properties/colloections. Here is a sample:
+
+```ruby
+module MessageRepresenter
+  include Roar::JSON
+  include Expandable
+
+  property :id
+  property :subject
+  property :body, expandable: true
+  collection :attachments, extend: AttachmentRepresenter, class: Attachment, expandable: true
+end
+```
+
+In the above example `attachments` are expandable which means by default they won't get rendered in `MessageRepresenter`. In order to explicitly add them to representer we need to set `expand` options of representer using `to_json` method:
+
+```ruby
+message = Message.new(id: 'test', subject: 'test subject', body: 'test body', attachments: ['1', '2'])
+message.extend(MessageRepresenter).to_json(expand: ['attachments'])
+```
+Note that `expand` gets an array as input.
+
+
+##Problems?
+
+Please create a Github issue once you find any issue or had any requests.
+
+##Thanks
+Special thanks to [@joeyAghion](https://github.com/joeyAghion) 
+
+##License
+
+Please see [LICENSE](LICENSE) for licensing details.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: [:spec]

data/lib/representable/expandable.rb

@@ -0,0 +1,25 @@
+module Representable
+  module Expandable
+    def self.included(base)
+      base.class_eval do
+        def self.collection(name, options = {}, &block)
+          add_expandable(name, options)
+          super
+        end
+
+        def self.property(name, options = {}, &block)
+          add_expandable(name, options)
+          super
+        end
+
+        def self.add_expandable(name, options = {})
+          if options.delete :expandable
+            # if collection already had if, and it with expandable if condition
+            existing_if = options[:if] || ->(_opts) { true }
+            options[:if] = ->(opts) { opts[:expand] && opts[:expand].include?(name.to_s) && existing_if.call(opts) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/representable/expandable/version.rb

@@ -0,0 +1,5 @@
+module Representable
+  module Expandable
+    VERSION = '1.0.0'
+  end
+end

data/lib/representable_expandable.rb

@@ -0,0 +1,2 @@
+require 'representable/expandable/version'
+require 'representable/expandable'

data/representable_expandable.gemspec

@@ -0,0 +1,15 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'representable/expandable/version'
+Gem::Specification.new do |s|
+  s.name = 'representable-expandable'
+  s.version = Representable::Expandable::VERSION
+  s.authors = ['Ashkan Nasseri']
+  s.email = 'ashkan.nasseri@gmail.com'
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage = 'https://github.com/ashkan18/representable-expandable'
+  s.licenses = ['MIT']
+  s.summary = 'Expandable extension for Representable'
+end

data/spec/representable/expandable/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Representable::Expandable do
+  it 'has a version' do
+    expect(Representable::Expandable::VERSION).not_to be_nil
+  end
+end

data/spec/representable/expandable_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Representable::Expandable do
+  before do
+    class Song < OpenStruct
+    end
+    module SongExpandable
+      include Representable::JSON
+      include Representable::Expandable
+      property :name, expandable: true
+      collection :genres, expandable: true
+    end
+    @song = Song.new(name: 'Summertime', genres: ['jazz', 'classic'])
+  end
+  context 'property' do
+    it 'does not include name when not expanded' do
+      response = @song.extend(SongExpandable).to_json
+      expect(response).not_to include 'name'
+    end
+
+    it 'includes name when expanded' do
+      response = @song.extend(SongExpandable).to_json(expand: ['name'])
+      expect(response).to include 'name'
+    end
+  end
+
+  context 'collection' do
+    it 'does not include genres when not expanded' do
+      response = @song.extend(SongExpandable).to_json
+      expect(response).not_to include 'genres'
+    end
+
+    it 'includes name when expanded' do
+      response = @song.extend(SongExpandable).to_json(expand: ['genres'])
+      expect(response).to include 'genres'
+    end
+  end
+
+  context 'expand list' do
+    it 'includes genres and names when both' do
+      response = @song.extend(SongExpandable).to_json(expand: ['genres', 'name'])
+      expect(response).to include 'genres'
+      expect(response).to include 'name'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'representable/json'
+require 'representable_expandable'
+require 'ostruct'

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: representable-expandable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ashkan Nasseri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-14 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: ashkan.nasseri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/representable/expandable.rb
+- lib/representable/expandable/version.rb
+- lib/representable_expandable.rb
+- representable_expandable.gemspec
+- spec/representable/expandable/version_spec.rb
+- spec/representable/expandable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ashkan18/representable-expandable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Expandable extension for Representable
+test_files: []