supa 0.1.4 → 0.2.0

data/.travis.yml

@@ -2,11 +2,19 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.1
-before_install: gem install bundler -v 1.13.1
+
+notifications:
+  email: false
+
 addons:
   code_climate:
-    repo_token: eb758a7a8b04369f929aa1b962bc9764b6517539971b785600065cf5ad93e282
+    repo_token: ad743cd1c267d4a84bfa620869f906a68efba51baa3aadc0638b88330ce3ab3a
+
+cache:
+  - bundler
+
+before_install: gem install bundler -v 1.13.7
+script:
+  - bundle exec rake
 after_success:
   - bundle exec codeclimate-test-reporter
-notifications:
-  email: false

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in supa.gemspec
 gemspec

data/README.md

@@ -2,10 +2,10 @@
 
 Ruby object → JSON serialization.
 
-[![Build Status](https://travis-ci.org/dasnotme/supa.svg?branch=master)](https://travis-ci.org/dasnotme/supa)
-[![Code Climate](https://codeclimate.com/github/dasnotme/supa/badges/gpa.svg)](https://codeclimate.com/github/dasnotme/supa)
-[![Test Coverage](https://codeclimate.com/github/dasnotme/supa/badges/coverage.svg)](https://codeclimate.com/github/dasnotme/supa/coverage)
-[![Issue Count](https://codeclimate.com/github/dasnotme/supa/badges/issue_count.svg)](https://codeclimate.com/github/dasnotme/supa)
+[![Build Status](https://travis-ci.org/distribusion/supa.svg?branch=master)](https://travis-ci.org/distribusion/supa)
+[![Code Climate](https://codeclimate.com/repos/587387071c36ea7203000e0d/badges/19b714c64bf6f028a58c/gpa.svg)](https://codeclimate.com/repos/587387071c36ea7203000e0d/feed)
+[![Test Coverage](https://codeclimate.com/repos/587387071c36ea7203000e0d/badges/19b714c64bf6f028a58c/coverage.svg)](https://codeclimate.com/repos/587387071c36ea7203000e0d/coverage)
+[![Issue Count](https://codeclimate.com/repos/587387071c36ea7203000e0d/badges/19b714c64bf6f028a58c/issue_count.svg)](https://codeclimate.com/repos/587387071c36ea7203000e0d/feed)
 
 ## Introduction
 
@@ -83,7 +83,7 @@ class ArticleRepresenter
       end
     end
 
-    polymorphic :included, getter: proc { [self.author] } do
+    collection :included, getter: proc { [self.author] } do
       attribute :id
       attribute :type, getter: proc { 'authors' }
 
@@ -93,7 +93,7 @@ class ArticleRepresenter
       end
     end
 
-    polymorphic :included, getter: proc { self.comments } do
+    collection :included, getter: proc { self.comments }, squash: true  do
       attribute :id
       attribute :type, getter: proc { 'comments' }
 
@@ -177,7 +177,52 @@ ArticleRepresenter.new(Article.new).to_json
 
 ### `collection`
 
-### `polymorphic`
+#### `:squash` option
+
+Passing `true` to `:squash` option results in merging collection with the previous one
+
+```ruby
+class AnimalsRepresenter
+  include Supa::Representable
+
+  define do
+    collection :animals, getter: -> { [{name: 'Rex', type: 'dogs'}] } do
+      attribute :name
+      attribute :type
+    end
+
+    collection :animals, getter: -> { [{name: 'Tom', type: 'cats'}] }, squash: true do
+      attribute :name
+      attribute :type
+    end
+  end
+end
+```
+
+```ruby
+ AnimalsRepresenter.new(nil).to_hash
+```
+
+```ruby
+{
+  animals: [
+    {name: 'Rex', type: 'dogs'},
+    {name: 'Tom', type: 'cats'}
+  ]
+}
+```
+
+### `:getter` option
+
+Avoid passing Proc objects to `:getter` option because this is little slower than method name passing
+
+```ruby
+# Bad
+attribute :name, getter: -> { fetch_name }
+
+# Good
+attribute :name, getter: :fetch_name
+```
 
 ## Development
 
@@ -203,10 +248,9 @@ bin/console
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/dasnotme/supa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/distribusion/supa.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,14 +1,6 @@
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << %w(spec lib)
-  t.test_files = FileList['spec/**/*_spec.rb']
-end
+RSpec::Core::RakeTask.new(:spec)
 
-Rake::TestTask.new(:bench) do |t|
-  t.libs << %w(spec lib)
-  t.test_files = FileList['spec/benchmarks/**/*_bench.rb']
-end
-
-task :default => :test
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "supa"
+require 'bundler/setup'
+require 'supa'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "supa"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start
+require 'pry-byebug'
+Pry.start

data/lib/supa/builder.rb

@@ -1,39 +1,34 @@
-require 'supa/commands/attribute'
-require 'supa/commands/object'
-require 'supa/commands/namespace'
-require 'supa/commands/collection'
-require 'supa/commands/polymorphic'
-
 module Supa
   class Builder
-    COMMANDS = %w(attribute object namespace collection polymorphic).freeze
+    COMMANDS = %w(attribute object namespace collection).freeze
 
     COMMANDS.each do |command|
       klass = Supa::Commands.const_get(command.capitalize)
 
       define_method command do |name, options = {}, &block|
-        klass.new(context: context,
-                  tree: tree,
-                  name: name,
-                  options: options,
-                  &block).represent
+        klass.new(
+          @object,
+          tree: @tree,
+          representer: @representer,
+          name: name,
+          options: options,
+          &block
+        ).represent
       end
     end
 
-    def initialize(context:, tree:)
-      @context = context
+    def initialize(object, tree:, representer:)
+      @object = object
       @tree = tree
+      @representer = representer
     end
 
     def to_hash
-      tree.to_hash
+      @tree.to_hash
     end
 
     def to_json
       to_hash.to_json
     end
-
-    private
-    attr_reader :context, :tree
   end
 end

data/lib/supa/command.rb

@@ -1,8 +1,9 @@
 module Supa
   class Command
-    def initialize(context:, tree:, name:, options: {}, &block)
-      @context = context
+    def initialize(object, tree:, representer:, name:, options: {}, &block)
+      @object = object
       @tree = tree
+      @representer = representer
       @name = name
       @options = options
       @block = block
@@ -13,14 +14,43 @@ module Supa
     end
 
     private
-    attr_reader :context, :tree, :name, :options, :block
 
-    def get_value
-      if options[:getter].is_a?(Proc)
-        context.instance_exec(&options[:getter])
-      else
-        context.is_a?(Hash) ? context[name] : context.send(name)
+    def value
+      return instance_exec(&value_accessor) if value_accessor.respond_to?(:call)
+
+      extracted_value = derived_value_from_object(@object) || derived_value_from_object(@representer)
+      extracted_value ||= literal_value
+
+      raise_no_method_error(value_accessor) if extracted_value.nil?
+      extracted_value
+    end
+
+    def value_accessor
+      @value_accessor ||= @options.fetch(:getter, @name)
+    end
+
+    def derived_value_from_object(object)
+      if value_accessor.respond_to?(:to_sym) && object.respond_to?(value_accessor)
+        object.send(value_accessor.to_sym)
+      elsif object.is_a?(Hash)
+        object.dig(value_accessor)
       end
     end
+
+    def literal_value
+      return if value_accessor.respond_to?(:call)
+      value_accessor unless value_accessor.is_a?(Symbol) || value_accessor.is_a?(Enumerable)
+    end
+
+    def raise_no_method_error(method_sym)
+      raise NoMethodError, "undefined method `#{method_sym}' for #{@object} or #{@representer}"
+    end
+
+    def method_missing(method_sym, *args, &block)
+      return @representer.send(method_sym, *args, &block) if @representer.respond_to?(method_sym)
+      return @object.send(method_sym, *args, &block) if @object.respond_to?(method_sym)
+
+      raise_no_method_error(method_sym)
+    end
   end
 end

data/lib/supa/commands/attribute.rb

@@ -1,10 +1,8 @@
-require 'supa/command'
-
 module Supa
   module Commands
     class Attribute < Supa::Command
       def represent
-        tree[name] = get_value
+        @tree[@name] = value
       end
     end
   end

data/lib/supa/commands/collection.rb

@@ -1,15 +1,15 @@
-require 'supa/command'
-
 module Supa
   module Commands
     class Collection < Supa::Command
+      include Supa::Commands::Collectionable
+
       def represent
-        tree[name] = []
+        @tree[@name] = [] unless @options[:squash]
 
-        Array(get_value).each do |element|
-          tree[name] << {}
+        collection.each do |element|
+          @tree[@name] << {}
 
-          Supa::Builder.new(context: element, tree: tree[name][-1]).instance_exec(&block)
+          Supa::Builder.new(element, tree: @tree[@name][-1], representer: @representer).instance_exec(&@block)
         end
       end
     end

data/lib/supa/commands/namespace.rb

@@ -1,15 +1,11 @@
-require 'supa/command'
-
 module Supa
   module Commands
     class Namespace < Supa::Command
       def represent
-        tree[name] = {}
+        @tree[@name] = {}
 
-        Supa::Builder.new(context: context, tree: tree[name]).instance_exec(&block)
+        Supa::Builder.new(@object, tree: @tree[@name], representer: @representer).instance_exec(&@block)
       end
     end
   end
 end
-
-

data/lib/supa/commands/object.rb

@@ -1,12 +1,10 @@
-require 'supa/command'
-
 module Supa
   module Commands
     class Object < Supa::Command
       def represent
-        tree[name] = {}
+        @tree[@name] = {}
 
-        Supa::Builder.new(context: get_value, tree: tree[name]).instance_exec(&block)
+        Supa::Builder.new(value, tree: @tree[@name], representer: @representer).instance_exec(&@block)
       end
     end
   end

data/lib/supa/commands/traits/collectionable.rb

@@ -0,0 +1,12 @@
+module Supa
+  module Commands
+    module Collectionable
+      private
+
+      def collection
+        collection = value
+        collection.is_a?(Array) ? collection : [collection]
+      end
+    end
+  end
+end

data/lib/supa/representable.rb

@@ -11,7 +11,7 @@ module Supa
       end
 
       def to_hash
-        Supa::Builder.new(context: object, tree: {}).tap do |builder|
+        Supa::Builder.new(@object, tree: {}, representer: self).tap do |builder|
           builder.instance_exec(&self.class.definition)
         end.to_hash
       end
@@ -19,9 +19,6 @@ module Supa
       def to_json
         to_hash.to_json
       end
-
-      private
-      attr_reader :object
     end
 
     module ClassMethods

data/lib/supa/version.rb

@@ -1,3 +1,3 @@
 module Supa
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'.freeze
 end

data/lib/supa.rb

@@ -1,6 +1,12 @@
 require 'supa/version'
-require 'supa/builder'
 require 'supa/representable'
+require 'supa/command'
+require 'supa/commands/traits/collectionable'
+require 'supa/commands/attribute'
+require 'supa/commands/object'
+require 'supa/commands/namespace'
+require 'supa/commands/collection'
+require 'supa/builder'
 
 module Supa
 end

data/supa.gemspec

@@ -1,30 +1,37 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'supa/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "supa"
+  spec.name          = 'supa'
   spec.version       = Supa::VERSION
   spec.platform      = Gem::Platform::RUBY
-  spec.authors       = ["Das"]
-  spec.email         = [""]
+  spec.authors       = ['Andrey Duplichev', 'Jan Rietema', 'Jakub Gorzelak']
+  spec.email         = %w(
+    andrey.duplichev@distribusion.com
+    jan.rietema@distribusion.com
+    jakub.gorzelak@distribusion.com
+  )
 
-  spec.summary       = "Ruby object → JSON serialization."
-  spec.description   = "Ruby object → JSON serialization."
-  spec.homepage      = "https://github.com/dasnotme/supa"
-  spec.license       = "MIT"
+  spec.summary       = 'Ruby object → JSON serialization.'
+  spec.description   = 'Ruby object → JSON serialization.'
+  spec.homepage      = 'https://github.com/distribusion/supa'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "simplecov", "~> 0.12"
-  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-benchmark', '~> 0.2.0'
+  spec.add_development_dependency 'rubocop', '~> 0.45.0'
+  spec.add_development_dependency 'reek', '~> 4.5.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4.0'
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: supa
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
-- Das
+- Andrey Duplichev
+- Jan Rietema
+- Jakub Gorzelak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,19 +41,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -80,15 +124,33 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
 description: Ruby object → JSON serialization.
 email:
-- ''
+- andrey.duplichev@distribusion.com
+- jan.rietema@distribusion.com
+- jakub.gorzelak@distribusion.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".gitignore"
+- ".reek"
+- ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -105,11 +167,11 @@ files:
 - lib/supa/commands/collection.rb
 - lib/supa/commands/namespace.rb
 - lib/supa/commands/object.rb
-- lib/supa/commands/polymorphic.rb
+- lib/supa/commands/traits/collectionable.rb
 - lib/supa/representable.rb
 - lib/supa/version.rb
 - supa.gemspec
-homepage: https://github.com/dasnotme/supa
+homepage: https://github.com/distribusion/supa
 licenses:
 - MIT
 metadata: {}

data/lib/supa/commands/polymorphic.rb

@@ -1,17 +0,0 @@
-require 'supa/command'
-
-module Supa
-  module Commands
-    class Polymorphic < Supa::Command
-      def represent
-        tree[name] ||= []
-
-        Array(get_value).each do |element|
-          tree[name] << {}
-
-          Supa::Builder.new(context: element, tree: tree[name][-1]).instance_exec(&block)
-        end
-      end
-    end
-  end
-end