jsonapi-materializer 1.0.0.rc5 → 1.0.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45e2b33985d2730ab66005e7e0189c6106cd390098f15bc896a972f6c1d6355a
-  data.tar.gz: e1cba7ed4b60dafe3979b6e7d6317311e5a65d0b0b202947d00c0b01bc0ccc13
+  metadata.gz: 93a0db9fffecd96a8bcf6cad1c1ac91770f7c0d06879fa8db306b6fcc7018ef3
+  data.tar.gz: 32327fa9622fe5bd18684e5d97796be5aee9a2335041fd64a3a694de40e5d5d9
 SHA512:
-  metadata.gz: ee08a498093076a0125b46a08001ca82034f7deddd2654837885e896d74eddee6a6bd2a7a863dae16b5a589796c5c8b39d512d86cf2bdcb5c68f32a6496d91c6
-  data.tar.gz: 2250215080f11923be9f50bd67276b221a957437a0b8ac75b17360fd7be2935488167f11ab2ddecee7f505a3fb207587da55902cf537c40bc5f4de4ad64088b8
+  metadata.gz: b87be37188db64b0494162becd98e1ee33b96138c026171f8ee3f6b859bad5b3b8a80ff2a56f3d23e07411876dac6a22e91607c8583ade664664550bedc3173d
+  data.tar.gz: 27cdfd03895418eda4a92e5f453bba042e169796d6916e4dbd046d83c0066dd6fc46011eaa52053fda7d32fda61d24e8491a0ba1615aa093ba69488234d3983f

data/README.md

@@ -126,65 +126,6 @@ There is *nothing* specific about rails for this library, it can be used in any
   0. A place to store the configuration at boot (rails initializers)
 
 
-### policies (aka pundit)
-
-If you're using some sort of policy logic like pundit you'll have the ability to pass it as a context to the materializer:
-
-``` ruby
-class AccountsController < ApplicationController
-  def show
-    context = {
-      :policy => policy
-    }
-    render(
-      :json => AccountMaterializer::Resource.new(:object => object, :context => context)
-    )
-  end
-end
-```
-
-And now the use of that context object:
-
-``` ruby
-class AccountMaterializer
-  include(JSONAPI::Materializer::Resource)
-
-  type(:accounts)
-
-  has_many(:reviews, :class_name => "ReviewMaterializer")
-
-  has(:name, :visible => :readable_attribute?)
-
-  private def readable_attribute?(attribute)
-    context.policy.read_attribute?(attribute.from)
-  end
-end
-```
-
-You'll notice that context is an object, not a hash, when referenced on the materializer. That's because we give you the ability to enforce the context for saftey:
-
-``` ruby
-
-class AccountMaterializer
-  include(JSONAPI::Materializer::Resource)
-
-  type(:accounts)
-
-  has_many(:reviews, :class_name => "ReviewMaterializer")
-
-  has(:name, :visible => :readable_attribute?)
-
-  context.validates_presence_of(:policy)
-
-  private def readable_attribute?(attribute)
-     context.policy.read_attribute?(attribute.from)
-  end
-end
-```
-
-These are just aliases for ActiveModel::Validations.
-
-
 ### Sister Projects
 
 I'm already using jsonapi-materializer. and it's sister project [jsonapi-realizer](https://github.com/krainboltgreene/jsonapi-realizer.rb) in a new gem of mine that allows services to be discoverable: [jsonapi-home](https://github.com/krainboltgreene/jsonapi-home.rb).

data/lib/jsonapi/materializer.rb

@@ -22,7 +22,6 @@ module JSONAPI
       :default_identifier => :id
     )
     require_relative("materializer/collection")
-    require_relative("materializer/context")
     require_relative("materializer/resource")
 
     def self.configuration

data/lib/jsonapi/materializer/collection.rb

@@ -10,7 +10,6 @@ module JSONAPI
       attr_writer(:selects)
       attr_writer(:includes)
       attr_writer(:pagination)
-      attr_accessor(:context)
 
       delegate(:first_page?, :to => :object)
       delegate(:prev_page, :to => :object)
@@ -34,7 +33,7 @@ module JSONAPI
       end
 
       private def materializers
-        @materializers ||= object.map {|subobject| self.class.parent.new(:object => subobject, :selects => selects, :includes => includes, :context => context)}
+        @materializers ||= object.map {|subobject| self.class.parent.new(:object => subobject, :selects => selects, :includes => includes)}
       end
 
       private def links_pagination

data/lib/jsonapi/materializer/collection_spec.rb

@@ -2,8 +2,7 @@ require("spec_helper")
 
 RSpec.describe(JSONAPI::Materializer::Collection) do
   let(:described_class) {ArticleMaterializer::Collection}
-  let(:policy) {Class.new { def read_attribute?(type, name); true end}}
-  let(:collection) {described_class.new(:object => object, :includes => [["comments"], ["author"]], :context => {:policy => policy.new})}
+  let(:collection) {described_class.new(:object => object, :includes => [["comments"], ["author"]])}
 
   describe("#as_json") do
     subject {collection.as_json.deep_stringify_keys}

data/lib/jsonapi/materializer/resource.rb

@@ -19,18 +19,6 @@ module JSONAPI
           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, allow_blank: true)
 
         origin(JSONAPI::Materializer.configuration.default_origin)
@@ -42,7 +30,6 @@ module JSONAPI
       attr_accessor(:object)
       attr_writer(:selects)
       attr_writer(:includes)
-      attr_writer(:context)
       attr_reader(:raw)
 
       def initialize(**keyword_arguments)
@@ -50,7 +37,6 @@ module JSONAPI
 
         @raw = keyword_arguments
 
-        context.validate!
         validate!
       end
 
@@ -70,12 +56,9 @@ module JSONAPI
 
       private def exposed(mapping)
         if selects.any?
-          mapping.
-            select {|_, value| value.visible?(self)}.
-            slice(*selects.dig(type))
+          mapping.slice(*selects.dig(type))
         else
-          mapping.
-            select {|_, value| value.visible?(self)}
+          mapping
         end
       end
 
@@ -135,10 +118,6 @@ module JSONAPI
         @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|
@@ -172,41 +151,34 @@ 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
+            :from => from
           )
         end
 
-        def has_one(name, from: name, class_name:, visible: true)
+        def has_one(name, from: name, class_name:)
           @relations[name] = Relation.new(
             :owner => self,
             :type => :one,
             :name => name,
             :from => from,
-            :class_name => class_name,
-            :visible => visible
+            :class_name => class_name
           )
         end
 
-        def has_many(name, from: name, class_name:, visible: true)
+        def has_many(name, from: name, class_name:)
           @relations[name] = Relation.new(
             :owner => self,
             :type => :many,
             :name => name,
             :from => from,
-            :class_name => class_name,
-            :visible => visible
+            :class_name => class_name
           )
         end
 
-        def context
-          const_get("Context")
-        end
-
         def configuration
           @configuration ||= Configuration.new(
             :owner => self,

data/lib/jsonapi/materializer/resource/attribute.rb

@@ -7,12 +7,10 @@ module JSONAPI
         attr_accessor(:owner)
         attr_accessor(:name)
         attr_accessor(:from)
-        attr_accessor(:visible)
 
         validates_presence_of(:owner)
         validates_presence_of(:name)
         validates_presence_of(:from)
-        validate(:visible_callable)
 
         def initialize(**keyword_arguments)
           super(**keyword_arguments)
@@ -24,25 +22,9 @@ module JSONAPI
           subject.object.public_send(from)
         end
 
-        def visible?(subject)
-          return visible if [true, false].include?(visible)
-          return subject.send(visible, :attribute, self) if visible.is_a?(Symbol)
-          return visible.call(:attribute, self) if visible.respond_to?(:call)
-
-          true
-        end
-
         private def materializer_class
           class_name.constantize
         end
-
-        private def visible_callable
-          return if [true, false].include?(visible)
-          return if visible.is_a?(Symbol)
-          return if visible.respond_to?(:call)
-
-          errors.add(:visible, "not callable or boolean")
-        end
       end
     end
   end

data/lib/jsonapi/materializer/resource/relation.rb

@@ -9,14 +9,12 @@ module JSONAPI
         attr_accessor(:type)
         attr_accessor(:from)
         attr_accessor(:class_name)
-        attr_accessor(:visible)
 
         validates_presence_of(:owner)
         validates_presence_of(:name)
         validates_presence_of(:type)
         validates_presence_of(:from)
         validates_presence_of(:class_name)
-        validate(:visible_callable)
 
         def initialize(**keyword_arguments)
           super(**keyword_arguments)
@@ -46,14 +44,6 @@ module JSONAPI
           end
         end
 
-        def visible?(subject)
-          return visible if [true, false].include?(visible)
-          return subject.send(visible, type, self) if visible.is_a?(Symbol)
-          return visible.call(type, self) if visible.respond_to?(:call)
-
-          true
-        end
-
         private def fetch_relation(subject)
           @fetch_relationship ||= {}
           @fetch_relationship[checksum(subject)] ||= subject.object.public_send(from)
@@ -75,14 +65,6 @@ module JSONAPI
           class_name.constantize
         end
 
-        private def visible_callable
-          return if [true, false].include?(visible)
-          return if visible.is_a?(Symbol)
-          return if visible.respond_to?(:call)
-
-          errors.add(:visible, "not callable or boolean")
-        end
-
         private def unlessing(object, proc)
           unless proc.call()
             yield(object)

data/lib/jsonapi/materializer/resource_spec.rb

@@ -1,7 +1,7 @@
 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")

data/lib/jsonapi/materializer/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Materializer
-    VERSION = "1.0.0.rc5".freeze
+    VERSION = "1.0.0.rc6".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-materializer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc5
+  version: 1.0.0.rc6
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-04 00:00:00.000000000 Z
+date: 2019-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -246,7 +246,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

data/lib/jsonapi/materializer/context.rb

@@ -1,8 +0,0 @@
-module JSONAPI
-  module Materializer
-    module Context
-      extend(ActiveSupport::Concern)
-      include(ActiveModel::Model)
-    end
-  end
-end