supa 0.2.3 → 0.3.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
 
@@ -24,7 +24,7 @@ bundle install
 ```
 
 Or install it yourself as
-```
+```shell
 gem install supa
 ```
 
@@ -49,75 +49,77 @@ end
 ```
 
 ```ruby
-module Supa
-  class ArticleRepresenter
-    include Supa::Representable
+class ArticleRepresenter
+  include Supa::Representable
 
-    define do
-      namespace :jsonapi do
-        virtual :version, 1.1, modifier: :to_s
-      end
+  define do
+    namespace :jsonapi do
+      virtual :version, getter: 1.1, modifier: :to_s
+    end
 
-      namespace :meta do
-        attribute :locale, :language, exec_context: :representer
-      end
+    namespace :meta do
+      attribute :locale, getter: :language, exec_context: :representer
+      attribute :date, exec_context: :representer
+    end
 
-      namespace :data do
-        attribute :id
-        virtual :type, 'articles'
+    namespace :data do
+      attribute :id
+      virtual :type, getter: 'articles'
 
-        namespace :attributes do
-          attribute :title
-          attribute :text
-        end
+      namespace :attributes do
+        attribute :title
+        attribute :text
+      end
 
-        namespace :relationships do
-          object :author do
-            namespace :data do
-              attribute :id
-              virtual :type, 'authors'
-            end
+      namespace :relationships do
+        object :author do
+          namespace :data do
+            attribute :id
+            virtual :type, getter: 'authors'
           end
+        end
 
-          namespace :comments do
-            collection :data, :comments do
-              attribute :id
-              virtual :type, 'comments'
-            end
+        namespace :comments do
+          collection :data, getter: :comments do
+            attribute :id
+            virtual :type, getter: 'comments'
           end
         end
       end
+    end
 
-      collection :included, :author do
-        attribute :id
-        virtual :type, 'authors'
+    collection :included, getter: :author do
+      attribute :id
+      virtual :type, getter: 'authors'
 
-        namespace :attributes do
-          attribute :first_name
-          attribute :last_name
-        end
+      namespace :attributes do
+        attribute :first_name
+        attribute :last_name
       end
+    end
 
-      append :included, :comments do
-        attribute :id
-        virtual :type, 'comments'
+    append :included, getter: :comments do
+      attribute :id
+      virtual :type, getter: 'comments'
 
-        namespace :attributes do
-          attribute :text
-        end
+      namespace :attributes do
+        attribute :text
       end
     end
+  end
 
-    def to_s(value)
-      value.to_s
-    end
+  def to_s(value)
+    value.to_s
+  end
 
-    def language
-      'en'
-    end
+  def language
+    'en'
   end
-end
 
+  def date
+    Date.today.iso8601
+  end
+end
 ```
 
 ```ruby
@@ -130,7 +132,8 @@ ArticleRepresenter.new(Article.new).to_json
     "version": "1.1"
   },
   "meta": {
-    "locale": "en"
+    "locale": "en",
+    "date": "2050-01-01"
   },
   "data": {
     "id": "7aa15512-1f9d-4a86-98ad-4bb0aae487a2",
@@ -188,9 +191,92 @@ ArticleRepresenter.new(Article.new).to_json
 ```
 
 ### `attribute`
+Attributes will be retrieved from correspondingly named instance methods unless a getter is defined:
+```ruby
+class ExampleRepresenter
+  include Supa::Representable
+
+  define do
+    attribute :name
+  end
+end
+
+ExampleRepresenter.new(OpenStruct.new(name: 'Heidi')).to_hash
+
+  #=> {
+  #=>   name: 'Heidi'
+  #=> }
+```
+A getter can take several forms:
+
+### 1. Method name
+```ruby
+class ExampleRepresenter
+  include Supa::Representable
+
+  define do
+    attribute :name, getter: :full_name
+  end
+end
+
+class Person
+  attr_accessor :full_name
+end
+
+example = Person.new
+example.full_name = 'Heidi Shepherd'
+
+ExampleRepresenter.new(example).to_hash
+
+  #=> {
+  #=>   name: 'Heidi Shepherd'
+  #=> }
+```
+The lookup order is to first check the object instance and then the representer for a matching method.
+
+###2. Hash key
+```ruby
+class ExampleRepresenter
+  include Supa::Representable
+
+  define do
+    attribute :name, getter: 'full_name'
+  end
+end
+
+example = {
+  'full_name' => 'Heidi Shepherd'
+}
+
+ExampleRepresenter.new(example).to_hash
+
+  #=> {
+  #=>   name: 'Heidi Shepherd'
+  #=> }
+
+```
 
 ### `virtual`
 
+Virtual is an attribute that doesn't exist in representing object and defind as `string`.
+```ruby
+class ExampleRepresenter
+  include Supa::Representable
+
+  define do
+    attribute :version, getter: 1.0
+    attribute :type, getter: 'documentation'
+  end
+end
+
+ExampleRepresenter.new({}).to_hash
+
+{
+  version: 1.0,
+  type: 'documentation',
+}
+```
+
 ### `namespace`
 
 ### `object`
@@ -223,10 +309,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.rb

@@ -1,6 +1,14 @@
 require 'supa/version'
-require 'supa/builder'
 require 'supa/representable'
+require 'supa/command'
+require 'supa/commands/attribute'
+require 'supa/commands/virtual'
+require 'supa/commands/object'
+require 'supa/commands/namespace'
+require 'supa/commands/collection'
+require 'supa/commands/append'
+
+require 'supa/builder'
 
 module Supa
 end

data/lib/supa/builder.rb

@@ -1,43 +1,32 @@
-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 virtual object namespace collection append).freeze
 
+    def initialize(subject, representer:, tree:)
+      @subject = subject
+      @representer = representer
+      @tree = tree
+    end
+
     COMMANDS.each do |command|
       klass = Supa::Commands.const_get(command.capitalize)
 
-      define_method command do |name, options = {}, &block|
-        klass.new(representer: representer,
-                  context: context,
-                  tree: tree,
-                  name: name,
-                  options: options,
-                  &block).represent
+      define_method(command) do |name, options = {}, &block|
+        klass.new(@subject,
+          representer: @representer,
+          tree: @tree,
+          name: name,
+          options: options,
+          &block).represent
       end
     end
 
-    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,8 +1,8 @@
 module Supa
   class Command
-    def initialize(representer:, context:, tree:, name:, options: {}, &block)
+    def initialize(subject, representer:, tree:, name:, options: {}, &block)
+      @subject = subject
       @representer = representer
-      @context = context
       @tree = tree
       @name = name
       @options = options
@@ -14,50 +14,47 @@ module Supa
     end
 
     private
-    attr_reader :representer, :context, :tree, :name, :options, :block
 
-    def apply_modifier(value)
-      with_modifier? ? representer.send(modifier, value) : value
+    def value
+      return @representer.send(@options[:modifier], apply_render_flags(raw_value)) if @options[:modifier]
+      apply_render_flags(raw_value)
     end
 
-    def modifier
-      options[:modifier]
+    def apply_render_flags(val)
+      val
     end
 
-    def with_modifier?
-      !!options[:modifier]
+    def raw_value
+      exec_on_representer? ? value_from_representer : value_from_subject
     end
 
-    def static_value
-      value = getter
-
-      apply_modifier(value)
+    def value_from_subject
+      return @subject[getter] if @subject.is_a?(Hash)
+      @subject.send(getter) if @subject
     end
 
-    def dynamic_value
-      value = if exec_on_object?
-        value_from_object
-      else
-        value_from_representer
-      end
+    def value_from_representer
+      @representer.send(getter)
+    end
 
-      apply_modifier(value)
+    def exec_on_representer?
+      @options[:exec_context] == :representer
     end
 
-    def exec_on_object?
-      options[:exec_context] != :representer
+    def getter
+      @options[:getter] || @name
     end
 
-    def value_from_object
-      context.is_a?(Hash) ? context[getter] : context.send(getter)
+    def hide_when_empty?
+      @options.fetch(:hide_when_empty, false)
     end
 
-    def value_from_representer
-      representer.send(getter)
+    def empty_when_nil?
+      @options.fetch(:empty_when_nil, false)
     end
 
-    def getter
-      options[:getter] || @name
+    def hide?
+      false
     end
   end
 end