simple_json_api 0.0.3 → 0.0.4

data/test/integration/serializers_test.rb

@@ -35,7 +35,7 @@ module SimpleJsonApi
           primary_key: :id
         }
       ]
-      ResourceSerializer.registered_serializers.must_equal expected
+      Serializer.registered_serializers.must_equal expected
     end
   end
 end

data/test/setup/data.rb

@@ -15,10 +15,14 @@ list1 = project1.create_todolist(id: 200, description: 'Groceries')
 list1.tags << tag3
 todo1 = list1.todos.create(id: 300, action: 'Milk')
 todo1.tags << tag1
-todo1.tags << tag2
+todo1.tags << tag3
+
+todo2 = list1.todos.create(id: 301, action: 'Bread')
+todo2.tags << tag1
+
 
 list2 = project2.create_todolist(id: 210, description: 'Work')
 list2.todos.create(id: 310, action: 'Timesheet')
 list2.todos.create(id: 320, action: 'Meeting')
-todo2 = list2.todos.create(id: 330, action: 'Bread')
-todo2.tags << tag1
+todo3 = list2.todos.create(id: 330, action: 'Present Agenda')
+todo3.tags << tag1

data/test/setup/serializers.rb

@@ -20,6 +20,7 @@ end
 # TodoSerializer for testing
 class TodoSerializer < SimpleJsonApi::ResourceSerializer
   serializes :todos, model: Todo
+  default_fields %w(id action)
   attribute :id
   attribute :action
   attribute :location
@@ -45,6 +46,7 @@ end
 # ProjectSerializer for testing
 class ProjectSerializer < SimpleJsonApi::ResourceSerializer
   serializes :projects, model: Project
+  required_associations %w(todolists)
   attribute :id
   attribute :name, key: :project_name
   attribute :description

data/test/test_helper.rb

@@ -22,13 +22,7 @@ Minitest::Reporters.use!(
 require 'ap'
 require 'simple_json_api'
 require 'test_setup'
-require 'diffy'
-
-# Helper to highlight diffs between two json strings
-#   compare_json(actual_projects, expected_projects.to_json)
-def compare_json(actual_json, expected_json)
-  actual_pretty = JSON.pretty_generate(JSON.parse(actual_json))
-  expected_pretty = JSON.pretty_generate(JSON.parse(expected_json))
-  diff =  Diffy::Diff.new(actual_pretty, expected_pretty)
-  puts "\n#{diff}\n" unless diff.to_s.empty?
+require 'minitest-match_json'
+Minitest::MatchJson.configure do |config|
+  config.format = :color
 end

data/test/unit/field_list_test.rb

@@ -3,15 +3,6 @@ require 'test_helper'
 # SimpleJsonApi
 module SimpleJsonApi
   describe 'FieldListTest' do
-    it 'should parse string field list' do
-      fl = FieldList.new(
-        'id,name',
-        ProjectSerializer
-      )
-      fl.fields_for(:projects).must_equal %w(id name)
-      fl.fields_for(:todos).must_equal nil
-    end
-
     it 'should parse hash field list' do
       fl = FieldList.new(
         {
@@ -23,6 +14,5 @@ module SimpleJsonApi
       fl.fields_for(:projects).must_equal %w(id name)
       fl.fields_for(:todos).must_equal %w(id description)
     end
-
   end
 end

data/test/unit/include_list_test.rb

@@ -5,15 +5,45 @@ module SimpleJsonApi
   describe 'IncludeListTest' do
     it 'should parse string include list' do
       il = IncludeList.new('todos,projects').parse
-      assert il.include?(:projects)
-      refute il.include?(:todo_lists)
+      expected = {
+        todos: {
+          include: true
+        },
+        projects: {
+          include: true
+        }
+      }
+      il.include_hash.must_equal expected
     end
 
     it 'should parse string for nested include list' do
       il = IncludeList.new('todos,projects.todolists').parse
-      refute il.include?(:projects)
-      assert il.include?(:todos)
-      assert il.include?(:todolists, [:projects])
+      expected = {
+        todos: {
+          include: true
+        },
+        projects: {
+          todolists: {
+            include: true
+          }
+        }
+      }
+      il.include_hash.must_equal expected
+    end
+
+    it 'should parse string for nested include list skipping middle' do
+      il = IncludeList.new('todolist,todolist.todos.tags').parse
+      expected = {
+        todolists: {
+          include: true,
+          todos: {
+            tags: {
+              include: true
+            }
+          }
+        }
+      }
+      il.include_hash.must_equal expected
     end
   end
 end

data/test/unit/symbol_refinement_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+require 'simple_json_api/refinements/symbol'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  describe 'SymbolRefinementTest' do
+    using Refinements::Symbol
+    it 'should pluralize a symbol' do
+      :dog.pluralize.must_equal(:dogs)
+    end
+
+    it 'should singularize a symbol' do
+      :dogs.singularize.must_equal(:dog)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_json_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Gary Gordon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-21 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,90 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: diffy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A basic serializer implementing the JSON API spec.
 email:
 - gfgordon@gmail.com
@@ -152,19 +68,36 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/simple_json_api/resource/USAGE
+- lib/generators/simple_json_api/resource/resource_generator.rb
+- lib/generators/simple_json_api/resource/templates/controller_template.rb.erb
+- lib/generators/simple_json_api/resource/templates/serializer_template.rb.erb
 - lib/simple_json_api.rb
-- lib/simple_json_api/active_record_refinements.rb
-- lib/simple_json_api/array_refinements.rb
+- lib/simple_json_api/api_node.rb
 - lib/simple_json_api/array_serializer.rb
+- lib/simple_json_api/association.rb
+- lib/simple_json_api/attribute.rb
+- lib/simple_json_api/builder.rb
 - lib/simple_json_api/dsl.rb
 - lib/simple_json_api/field_list.rb
+- lib/simple_json_api/helper.rb
 - lib/simple_json_api/include_list.rb
-- lib/simple_json_api/json_api_builder.rb
+- lib/simple_json_api/json_api_wrapper.rb
+- lib/simple_json_api/member/data.rb
+- lib/simple_json_api/member/included.rb
+- lib/simple_json_api/member/links.rb
+- lib/simple_json_api/member/meta.rb
+- lib/simple_json_api/refinements/active_record.rb
+- lib/simple_json_api/refinements/array.rb
+- lib/simple_json_api/refinements/symbol.rb
+- lib/simple_json_api/resource.rb
 - lib/simple_json_api/resource_serializer.rb
 - lib/simple_json_api/serializer.rb
+- lib/simple_json_api/serializer_factory.rb
 - lib/simple_json_api/version.rb
 - simple_json_api.gemspec
 - test/fixtures/projects.yml
+- test/generators/simple_json_api/resource_generator_test.rb
 - test/integration/render_basic_test.rb
 - test/integration/render_fields_test.rb
 - test/integration/render_include_test.rb
@@ -181,6 +114,7 @@ files:
 - test/unit/attribute_test.rb
 - test/unit/field_list_test.rb
 - test/unit/include_list_test.rb
+- test/unit/symbol_refinement_test.rb
 homepage: ''
 licenses:
 - MIT
@@ -207,6 +141,7 @@ specification_version: 4
 summary: A Simple JSON API Serializer.
 test_files:
 - test/fixtures/projects.yml
+- test/generators/simple_json_api/resource_generator_test.rb
 - test/integration/render_basic_test.rb
 - test/integration/render_fields_test.rb
 - test/integration/render_include_test.rb
@@ -223,3 +158,4 @@ test_files:
 - test/unit/attribute_test.rb
 - test/unit/field_list_test.rb
 - test/unit/include_list_test.rb
+- test/unit/symbol_refinement_test.rb

data/lib/simple_json_api/active_record_refinements.rb

@@ -1,21 +0,0 @@
-require 'active_record'
-
-# SimpleJsonApi
-module SimpleJsonApi
-  # Refinements on ActiveRecord
-  module ActiveRecordRefinements
-    refine ActiveRecord::Base do
-      def typed_json_id
-        [self.class.to_s.downcase.pluralize, json_id]
-      end
-
-      def json_id
-        send(json_pk).to_s
-      end
-
-      def json_pk
-        self.class.primary_key.to_sym
-      end
-    end
-  end
-end

data/lib/simple_json_api/array_refinements.rb

@@ -1,14 +0,0 @@
-require 'active_record'
-
-# SimpleJsonApi
-module SimpleJsonApi
-  # Refinements on Hash
-  module ArrayRefinements
-    refine Array do
-      using ActiveRecordRefinements
-      def already_linked?(key, id)
-        find { |elem| elem[key] == id }
-      end
-    end
-  end
-end

data/lib/simple_json_api/json_api_builder.rb

@@ -1,84 +0,0 @@
-# SimpleJsonApi
-module SimpleJsonApi
-  # The Builder to walk the hierarchy and contruct the JSON
-  class JsonApiBuilder
-    using ActiveRecordRefinements
-    using ArrayRefinements
-
-    extend Forwardable
-
-    attr_reader :serializer
-    attr_reader :model
-    attr_reader :_included_resources
-    attr_reader :include
-    attr_reader :field_list
-    attr_reader :result
-
-    def_delegators :@field_list, :fields_for
-
-    # TODO: sort: nil
-    def initialize(model, serializer, options = {})
-      @model = model
-      handle_options(options, serializer)
-      @serializer = get_serializer(serializer)
-      @_included_resources = {}
-      @result = {}
-      @linked = {}
-    end
-
-    def handle_options(options, serializer)
-      @field_list = FieldList.new(
-        options.fetch(:fields, nil),
-        serializer
-      )
-      @include = IncludeList.new(options.fetch(:include, nil)).parse
-    end
-
-    def as_json(options = nil)
-      build.as_json(options)
-    end
-
-    def build
-      result[@serializer._root_name] = @serializer.serialize
-      @result[:linked] = @linked unless @linked.empty?
-      @result
-    end
-
-    def add_linked_elem(elem, obj, association, base)
-      resource_name = elem.to_s.pluralize
-      obj = Array(obj) unless obj.respond_to?(:each)
-      obj.each do |item|
-        serialize_association(item, resource_name, association, base)
-      end
-    end
-
-    def serialize_association(item, resource_name, association, base)
-      # TODO: don't include middle unless explicitly requested.
-      return unless include.include?(resource_name, base)
-      assoc_base = [base, resource_name].compact.join('.')
-      serializer = ResourceSerializer.for(item, association)
-      add_to_linked(assoc_base, item, serializer)
-    end
-
-    def add_to_linked(assoc_base, item, serializer)
-      linked = @linked[serializer._root_name] ||= []
-      return if linked.already_linked?(item.json_pk, item.json_id)
-      linked << serializer.new(item, self, nil, assoc_base).serialize
-    end
-
-    private
-
-    def get_serializer(serializer)
-      if use_array_serializer?
-        ArraySerializer.new(@model, self, serializer)
-      else
-        serializer.new(@model, self)
-      end
-    end
-
-    def use_array_serializer?
-      @model.is_a?(Array) ||
-        @model.is_a?(ActiveRecord::Associations::CollectionProxy)
-    end
-  end
-end