supa 0.2.0 → 0.2.1

data/.travis.yml

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

data/Gemfile

@@ -1,3 +1,4 @@
 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/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)
+[![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)
 
 ## Introduction
 
@@ -49,60 +49,75 @@ end
 ```
 
 ```ruby
-class ArticleRepresenter
-  include Supa::Representable
+module Supa
+  class ArticleRepresenter
+    include Supa::Representable
 
-  define do
-    namespace :jsonapi do
-      attribute :version, getter: proc { 1.1 }
-    end
-
-    namespace :data do
-      attribute :id
-      attribute :type, getter: proc { 'articles' }
+    define do
+      namespace :jsonapi do
+        virtual :version, 1.1, modifier: :to_s
+      end
 
-      namespace :attributes do
-        attribute :title
-        attribute :text
+      namespace :meta do
+        attribute :locale, :language, exec_context: :representer
       end
 
-      namespace :relationships do
-        object :author do
-          namespace :data do
-            attribute :id
-            attribute :type, getter: proc { 'authors' }
-          end
+      namespace :data do
+        attribute :id
+        virtual :type, 'articles'
+
+        namespace :attributes do
+          attribute :title
+          attribute :text
         end
 
-        namespace :comments do
-          collection :data, getter: proc { self.comments } do
-            attribute :id
-            attribute :type, getter: proc { 'comments' }
+        namespace :relationships do
+          object :author do
+            namespace :data do
+              attribute :id
+              virtual :type, 'authors'
+            end
+          end
+
+          namespace :comments do
+            collection :data, :comments do
+              attribute :id
+              virtual :type, 'comments'
+            end
           end
         end
       end
-    end
 
-    collection :included, getter: proc { [self.author] } do
-      attribute :id
-      attribute :type, getter: proc { 'authors' }
+      collection :included, :author do
+        attribute :id
+        virtual :type, 'authors'
 
-      namespace :attributes do
-        attribute :first_name
-        attribute :last_name
+        namespace :attributes do
+          attribute :first_name
+          attribute :last_name
+        end
       end
-    end
 
-    collection :included, getter: proc { self.comments }, squash: true  do
-      attribute :id
-      attribute :type, getter: proc { 'comments' }
+      append :included, :comments do
+        attribute :id
+        virtual :type, 'comments'
 
-      namespace :attributes do
-        attribute :text
+        namespace :attributes do
+          attribute :text
+        end
       end
     end
+
+    def to_s(value)
+      value.to_s
+    end
+
+    def language
+      'en'
+    end
   end
 end
+
 ```
 
 ```ruby
@@ -112,7 +127,10 @@ ArticleRepresenter.new(Article.new).to_json
 ```json
 {
   "jsonapi": {
-    "version": 1.1
+    "version": "1.1"
+  },
+  "meta": {
+    "locale": "en"
   },
   "data": {
     "id": "7aa15512-1f9d-4a86-98ad-4bb0aae487a2",
@@ -171,58 +189,15 @@ ArticleRepresenter.new(Article.new).to_json
 
 ### `attribute`
 
+### `virtual`
+
 ### `namespace`
 
 ### `object`
 
 ### `collection`
 
-#### `: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
-```
+### `append`
 
 ## Development
 
@@ -248,9 +223,10 @@ bin/console
 
 ## Contributing
 
-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.
+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.
+
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

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 'pry-byebug'
-Pry.start
+require "irb"
+IRB.start

data/lib/supa.rb

@@ -1,12 +1,6 @@
 require 'supa/version'
-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'
+require 'supa/representable'
 
 module Supa
 end

data/lib/supa/builder.rb

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

data/lib/supa/command.rb

@@ -1,10 +1,11 @@
 module Supa
   class Command
-    def initialize(object, tree:, representer:, name:, options: {}, &block)
-      @object = object
-      @tree = tree
+    def initialize(representer:, context:, tree:, name:, getter:, options: {}, &block)
       @representer = representer
+      @context = context
+      @tree = tree
       @name = name
+      @getter = getter
       @options = options
       @block = block
     end
@@ -14,43 +15,50 @@ module Supa
     end
 
     private
+    attr_reader :representer, :context, :tree, :name, :options, :block
 
-    def value
-      return instance_exec(&value_accessor) if value_accessor.respond_to?(:call)
+    def apply_modifier(value)
+      with_modifier? ? representer.send(modifier, value) : value
+    end
 
-      extracted_value = derived_value_from_object(@object) || derived_value_from_object(@representer)
-      extracted_value ||= literal_value
+    def modifier
+      options[:modifier]
+    end
 
-      raise_no_method_error(value_accessor) if extracted_value.nil?
-      extracted_value
+    def with_modifier?
+      !!options[:modifier]
     end
 
-    def value_accessor
-      @value_accessor ||= @options.fetch(:getter, @name)
+    def static_value
+      value = getter
+
+      apply_modifier(value)
     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)
+    def dynamic_value
+      value = if exec_on_object?
+        value_from_object
+      else
+        value_from_representer
       end
+
+      apply_modifier(value)
     end
 
-    def literal_value
-      return if value_accessor.respond_to?(:call)
-      value_accessor unless value_accessor.is_a?(Symbol) || value_accessor.is_a?(Enumerable)
+    def exec_on_object?
+      options[:exec_context] != :representer
     end
 
-    def raise_no_method_error(method_sym)
-      raise NoMethodError, "undefined method `#{method_sym}' for #{@object} or #{@representer}"
+    def value_from_object
+      context.is_a?(Hash) ? context[getter] : context.send(getter)
     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)
+    def value_from_representer
+      representer.send(getter)
+    end
 
-      raise_no_method_error(method_sym)
+    def getter
+      @getter || @name
     end
   end
 end

data/lib/supa/commands/append.rb

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