jsonapi-materializer 1.0.0.rc.pre.1 → 1.0.0

data/lib/jsonapi/materializer/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Materializer
     module Resource
@@ -9,29 +11,17 @@ module JSONAPI
       extend(ActiveSupport::Concern)
       include(ActiveModel::Model)
 
-      MIXIN_HOOK = ->(*) do
+      MIXIN_HOOK = lambda do |*|
         @attributes = {}
         @relations = {}
 
-        unless const_defined?("Collection")
+        unless const_defined?(:Collection)
           self::Collection = Class.new do
             include(JSONAPI::Materializer::Collection)
           end
         end
 
-        unless const_defined?("Context")
-          self::Context = Class.new do
-            include(JSONAPI::Materializer::Context)
-
-            def initialize(**keyword_arguments)
-              keyword_arguments.keys.each(&singleton_class.method(:attr_accessor))
-
-              super(**keyword_arguments)
-            end
-          end
-        end
-
-        validates_presence_of(:object)
+        validates_presence_of(:object, allow_blank: true)
 
         origin(JSONAPI::Materializer.configuration.default_origin)
         identifier(JSONAPI::Materializer.configuration.default_identifier)
@@ -42,7 +32,6 @@ module JSONAPI
       attr_accessor(:object)
       attr_writer(:selects)
       attr_writer(:includes)
-      attr_writer(:context)
       attr_reader(:raw)
 
       def initialize(**keyword_arguments)
@@ -50,69 +39,38 @@ module JSONAPI
 
         @raw = keyword_arguments
 
-        context.validate!
         validate!
       end
 
       def as_data
         {
-          :id => id,
-          :type => type,
-          :attributes => exposed(attributes.except(:id)).
-            transform_values {|attribute| object.public_send(attribute.from)},
-          :relationships => exposed(relations).
-            transform_values {|relation| relation.using(self).as_json},
-          :links => {
-            :self => links_self
+          id:,
+          type:,
+          attributes: exposed(attributes.except(:id))
+            .transform_values { |attribute| object.public_send(attribute.from) },
+          relationships: exposed(relations)
+            .transform_values { |relation| relation.using(self).as_json },
+          links: {
+            self: links_self
           }
         }.transform_values(&:presence).compact
       end
-
-      private def exposed(mapping)
-        if selects.any?
-          mapping.
-            select {|_, value| value.visible?(self)}.
-            slice(*selects.dig(type))
-        else
-          mapping.
-            select {|_, value| value.visible?(self)}
-        end
-      end
+      # rubocop:enable Metrics/AbcSize
 
       def as_json(*)
         {
-          :links => {
-            :self => links_self
+          links: {
+            self: links_self
           },
-          :data => as_data,
-          :included => included
+          data: as_data,
+          included:
         }.transform_values(&:presence).compact
       end
 
-      private def id
-        object.public_send(identifier).to_s
-      end
-
       def type
         self.class.configuration.type.to_s
       end
 
-      private def attributes
-        self.class.configuration.attributes
-      end
-
-      private def origin
-        self.class.configuration.origin
-      end
-
-      private def identifier
-        self.class.configuration.identifier
-      end
-
-      private def relations
-        self.class.configuration.relations
-      end
-
       def attribute(name)
         self.class.attribute(name)
       end
@@ -128,35 +86,20 @@ module JSONAPI
       end
 
       def selects
-        (@selects || {}).transform_values {|list| list.map(&:to_sym)}
+        (@selects || {}).transform_values { |list| list.map(&:to_sym) }
       end
 
       def includes
         @includes || []
       end
 
-      def context
-        self.class.const_get("Context").new(**@context || {})
-      end
-
-      private def included
-        @included ||= includes.flat_map do |path|
-          path.reduce(self) do |subject, key|
-            if subject.is_a?(Array)
-              subject.map {|related_subject| related_subject.relation(key).for(subject)}
-            else
-              subject.relation(key).for(subject)
-            end
-          end
-        end.map(&:as_data)
-      end
-
       included do
         class_eval(&MIXIN_HOOK) unless @abstract_class
       end
 
       class_methods do
         def inherited(object)
+          super
           object.class_eval(&MIXIN_HOOK) unless object.instance_variable_defined?(:@abstract_class)
         end
 
@@ -172,60 +115,97 @@ module JSONAPI
           @type = value.to_sym
         end
 
-        def has(name, from: name, visible: true)
+        def has(name, from: name)
           @attributes[name] = Attribute.new(
-            :owner => self,
-            :name => name,
-            :from => from,
-            :visible => visible
+            owner: self,
+            name:,
+            from:
           )
         end
 
-        def has_one(name, from: name, class_name:, visible: true)
+        # rubocop:disable Naming/PredicateName
+        def has_one(name, class_name:, from: name)
           @relations[name] = Relation.new(
-            :owner => self,
-            :type => :one,
-            :name => name,
-            :from => from,
-            :class_name => class_name,
-            :visible => visible
+            owner: self,
+            type: :one,
+            name:,
+            from:,
+            class_name:
           )
         end
+        # rubocop:enable Naming/PredicateName
 
-        def has_many(name, from: name, class_name:, visible: true)
+        # rubocop:disable Naming/PredicateName
+        def has_many(name, class_name:, from: name)
           @relations[name] = Relation.new(
-            :owner => self,
-            :type => :many,
-            :name => name,
-            :from => from,
-            :class_name => class_name,
-            :visible => visible
+            owner: self,
+            type: :many,
+            name:,
+            from:,
+            class_name:
           )
         end
-
-        def context
-          const_get("Context")
-        end
+        # rubocop:enable Naming/PredicateName
 
         def configuration
           @configuration ||= Configuration.new(
-            :owner => self,
-            :type => @type,
-            :origin => @origin,
-            :identifier => @identifier,
-            :attributes => @attributes,
-            :relations => @relations
+            owner: self,
+            type: @type,
+            origin: @origin,
+            identifier: @identifier,
+            attributes: @attributes,
+            relations: @relations
           )
         end
 
         def attribute(name)
-          configuration.attributes.fetch(name.to_sym) {raise(Error::ResourceRelationshipNotFound, :name => name, :materializer => self)}
+          configuration.attributes.fetch(name.to_sym) { raise(Error::ResourceAttributeNotFound, name:, materializer: self) }
         end
 
         def relation(name)
-          configuration.relations.fetch(name.to_sym) {raise(Error::ResourceRelationshipNotFound, :name => name, :materializer => self)}
+          configuration.relations.fetch(name.to_sym) { raise(Error::ResourceRelationshipNotFound, name:, materializer: self) }
+        end
+      end
+
+      private def exposed(mapping)
+        if selects.any?
+          mapping.slice(*selects[type])
+        else
+          mapping
         end
       end
+
+      private def id
+        object.public_send(identifier).to_s
+      end
+
+      private def attributes
+        self.class.configuration.attributes
+      end
+
+      private def origin
+        self.class.configuration.origin
+      end
+
+      private def identifier
+        self.class.configuration.identifier
+      end
+
+      private def relations
+        self.class.configuration.relations
+      end
+
+      private def included
+        @included ||= includes.flat_map do |path|
+          path.reduce(self) do |subject, key|
+            if subject.is_a?(Array)
+              subject.map { |related_subject| related_subject.relation(key).for(subject) }
+            else
+              subject.relation(key).for(subject)
+            end
+          end
+        end.map(&:as_data)
+      end
     end
   end
 end

data/lib/jsonapi/materializer/resource_spec.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require("spec_helper")
 
 RSpec.describe(JSONAPI::Materializer::Resource) do
-  let(:resource) {ArticleMaterializer.new(:object => Article.find(1), :context => {:policy => true})}
+  let(:resource) { ArticleMaterializer.new(object: Article.find(1)) }
 
   before do
-    Account.create!(:id => 9, :name => "Dan Gebhardt", :twitter => "dgeb")
-    Account.create!(:id => 2, :name => "DHH", :twitter => "DHH")
-    Article.create!(:id => 1, :title => "JSON API paints my bikeshed!", :account => Account.find(9))
-    Comment.create!(:id => 5, :body => "First!", :article => Article.find(1), :account => Account.find(2))
-    Comment.create!(:id => 12, :body => "I like XML better", :article => Article.find(1), :account => Account.find(9))
+    Account.create!(id: 9, name: "Dan Gebhardt", twitter: "dgeb")
+    Account.create!(id: 2, name: "DHH", twitter: "DHH")
+    Article.create!(id: 1, title: "JSON API paints my bikeshed!", account: Account.find(9))
+    Comment.create!(id: 5, body: "First!", article: Article.find(1), account: Account.find(2))
+    Comment.create!(id: 12, body: "I like XML better", article: Article.find(1), account: Account.find(9))
   end
 
   describe("#to_json") do
-    subject {resource.as_json.deep_stringify_keys}
+    subject { resource.as_json.deep_stringify_keys }
 
     it("returns a JSON:API standards compliant payload") do
       expect(subject).to(
@@ -55,7 +57,7 @@ RSpec.describe(JSONAPI::Materializer::Resource) do
               }
             },
             "links" => {
-                "self" => "http://example.com/articles/1"
+              "self" => "http://example.com/articles/1"
             }
           }
         )

data/lib/jsonapi/materializer/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Materializer
-    VERSION = "1.0.0.rc-1".freeze
+    VERSION = "1.0.0"
   end
 end

data/lib/jsonapi/materializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require("ostruct")
 require("addressable")
 require("active_model")
@@ -8,7 +10,7 @@ require("active_support/core_ext/string")
 require("active_support/core_ext/module")
 
 module JSONAPI
-  MEDIA_TYPE = "application/vnd.api+json".freeze unless const_defined?("MEDIA_TYPE")
+  MEDIA_TYPE = "application/vnd.api+json" unless const_defined?(:MEDIA_TYPE)
 
   module Materializer
     require_relative("materializer/version")
@@ -17,12 +19,11 @@ module JSONAPI
     require_relative("materializer/controller")
 
     @configuration ||= Configuration.new(
-      :default_invalid_accept_exception => JSONAPI::Materializer::Error::InvalidAcceptHeader,
-      :default_missing_accept_exception => JSONAPI::Materializer::Error::MissingAcceptHeader,
-      :default_identifier => :id
+      default_invalid_accept_exception: JSONAPI::Materializer::Error::InvalidAcceptHeader,
+      default_missing_accept_exception: JSONAPI::Materializer::Error::MissingAcceptHeader,
+      default_identifier: :id
     )
     require_relative("materializer/collection")
-    require_relative("materializer/context")
     require_relative("materializer/resource")
 
     def self.configuration

data/lib/jsonapi/materializer_spec.rb

@@ -1,4 +1,3 @@
-require("spec_helper")
+# frozen_string_literal: true
 
-RSpec.describe(JSONAPI::Materializer) do
-end
+require("spec_helper")

data/lib/jsonapi-materializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   require_relative("jsonapi/materializer")
 end

metadata

@@ -1,157 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-materializer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.pre.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2018-12-28 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activemodel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.2'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: rubocop
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -159,79 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: activesupport
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 description: A way to turn data models into outbound json:api responses
 email:
 - kurtis@rainbolt-greene.online
@@ -239,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - Rakefile
 - lib/jsonapi-materializer.rb
@@ -246,7 +67,6 @@ files:
 - lib/jsonapi/materializer/collection.rb
 - lib/jsonapi/materializer/collection_spec.rb
 - lib/jsonapi/materializer/configuration.rb
-- lib/jsonapi/materializer/context.rb
 - lib/jsonapi/materializer/controller.rb
 - lib/jsonapi/materializer/error.rb
 - lib/jsonapi/materializer/error/invalid_accept_header.rb
@@ -260,30 +80,29 @@ files:
 - lib/jsonapi/materializer/resource/relationship.rb
 - lib/jsonapi/materializer/resource_spec.rb
 - lib/jsonapi/materializer/version.rb
-- lib/jsonapi/materializer/version_spec.rb
 - lib/jsonapi/materializer_spec.rb
-homepage: http://krainboltgreene.github.io/jsonapi-materializer
+homepage: http://krainboltgreene.github.io/jsonapi-materializer.rb
 licenses:
-- ISC
-metadata: {}
-post_install_message: 
+- HL3
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A way to turn data models into outbound json:api responses
 test_files: []