shreddies 0.4.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 362313f00cf053782a4cce7d2ce46b83e8ae078e6812c7c8bb485440f967c3a5
-  data.tar.gz: e1f3f78c27fc4def477bfc1f3adb13fb101a57fbc6870add99dbac9f8efb0db4
+  metadata.gz: 363f96d8b275cca63644e6f00b652f282b5129b81c3a12fb17327008fc61718f
+  data.tar.gz: 5bbb94d2a08893a4f1a42689197d283a6c614d41d021269c67378bf2f3fc90ad
 SHA512:
-  metadata.gz: 67d80f7708e475b54d8e99a5b24d4198091d0ccfef45a84c131539985bdc682bad234e3df12eb4e8351b3648296a2adffc71e796cd8b149a8336a85495d3acb3
-  data.tar.gz: 62e767958dd0b0cd314204a2a7cd573ae7d4df0dd27bdf23a528e64eb4574c2b3e45a5aa9879674a9264c7b57c462f784741a8926e0a82108043396a6caded9e
+  metadata.gz: 335a534a2da060a82c73178e4cf1353355179bfc1e53c20e14e1b65e3e4d52f60b2eeb71ebe312119b127932b864e6bd112629b0f56cd438fbb714e288a46888
+  data.tar.gz: c951402f510d006353c8b289908b50a2ab7eea5f07c093f173541f796a429c2e116ae384752042b131a124b87ebe17ea5b69108870a0070107f3ba6b8ab51a0a

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in shreddies.gemspec
 gemspec
 
-gem 'rake', '~> 12.0'
+gem 'rake', '~> 13.0'
 gem 'minitest', '~> 5.0'
 gem 'autotest-suffix'
 gem 'minitest-autotest'

data/Gemfile.lock

@@ -1,54 +1,54 @@
 PATH
   remote: .
   specs:
-    shreddies (0.3.0)
+    shreddies (0.7.0)
       activerecord (>= 5)
       railties (>= 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.3.2)
-      actionview (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     autotest-suffix (1.1.0)
     builder (3.2.4)
-    combustion (1.3.0)
+    combustion (1.3.1)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.8)
     crass (1.0.6)
-    erubi (1.9.0)
-    i18n (1.8.3)
+    erubi (1.10.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
     minitest-autotest (1.1.1)
       minitest-server (~> 1.0)
       path_expander (~> 1.0)
@@ -56,9 +56,11 @@ GEM
       minitest (>= 4, < 6)
     minitest-server (1.0.6)
       minitest (~> 5.0)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     path_expander (1.1.0)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -67,19 +69,18 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rake (12.3.3)
+      thor (~> 1.0)
+    rake (13.0.3)
     sqlite3 (1.4.2)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.3.1)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -90,9 +91,9 @@ DEPENDENCIES
   minitest (~> 5.0)
   minitest-autotest
   minitest-focus
-  rake (~> 12.0)
+  rake (~> 13.0)
   shreddies!
   sqlite3
 
 BUNDLED WITH
-   2.1.4
+   2.2.15

data/README.md

@@ -165,6 +165,24 @@ The `Collection` and `Single` modules can be defined and they will be automatica
 
 If false, the returned keys will not be transformed. The default is to deeply transform all keys to camelCase.
 
+#### `except`
+
+Pass one or more attribute names as a Symbol or Array of Symbols, and these will be excluded from the results:
+
+```ruby
+User.all.as_json(except: [:first_name, :age])
+```
+
+#### `only`
+
+Pass one or more attribute names as a Symbol or Array of Symbols, and _ONLY_ these will be included in the results:
+
+```ruby
+User.all.as_json(only: :first_name)
+```
+
+> Attributes must still be defined within the Serializer.
+
 #### `index_by`
 
 Give this option a property of your serialized subject as a Symbol, and the returned collection will be a Hash keyed by that property.

data/lib/shreddies/as_json.rb

@@ -8,6 +8,8 @@ module Shreddies
 
         if serializer.is_a?(String) || serializer.is_a?(Symbol)
           serializer = serializer.to_s.safe_constantize
+        elsif serializer.is_a?(Proc)
+          return serializer.call
         end
 
         serializer ? serializer.render_as_json(self, options) : super
@@ -20,6 +22,8 @@ module Shreddies
 
         if serializer.is_a?(String) || serializer.is_a?(Symbol)
           serializer = serializer.to_s.safe_constantize
+        elsif serializer.is_a?(Proc)
+          return serializer.call
         end
 
         serializer ? serializer.render_as_json(self, options) : super

data/lib/shreddies/json.rb

@@ -44,11 +44,11 @@ module Shreddies
       super(*methods, to: to, prefix: prefix, allow_nil: allow_nil, private: private)
     end
 
-    attr_reader :subject, :options, :from_collection
+    attr_reader :subject, :options
 
-    def initialize(subject, options)
+    def initialize(subject, opts = {})
       @subject = subject.is_a?(Hash) ? OpenStruct.new(subject) : subject
-      @options = { transform_keys: true }.merge(options)
+      @options = { transform_keys: true }.merge(opts).with_indifferent_access
 
       extend_with_modules
     end
@@ -65,10 +65,18 @@ module Shreddies
         end
       end
 
+      # Filter out methods using the `only` or `except` options.
+      if @options[:only]
+        @options[:only] = Array(@options[:only])
+        methods = methods.select { |x| @options[:only].include? x }
+      elsif @options[:except]
+        methods = methods.excluding(@options[:except])
+      end
+
       methods.map do |attr|
         res = public_send(attr)
         if res.is_a?(ActiveRecord::Relation) || res.is_a?(ActiveRecord::Base)
-          res = res.as_json(transform_keys: options[:transform_keys])
+          res = res.as_json(transform_keys: @options[:transform_keys])
         end
 
         output[attr] = res
@@ -76,7 +84,7 @@ module Shreddies
 
       output = before_render(output)
 
-      return output unless options[:transform_keys]
+      return output unless @options[:transform_keys]
 
       output.deep_transform_keys { |key| key.to_s.camelize :lower }
     end
@@ -93,7 +101,7 @@ module Shreddies
 
         # Extend with Collection module if it exists, and a collection is being rendered. Otherwise,
         # extend with the Single module if that exists.
-        if options[:from_collection]
+        if @options[:from_collection]
           (collection_mod = "#{ancestor}::Collection".safe_constantize) && extend(collection_mod)
         else
           (single_mod = "#{ancestor}::Single".safe_constantize) && extend(single_mod)
@@ -101,8 +109,8 @@ module Shreddies
       end
 
       # Extend with the :module option if given.
-      if options[:module]
-        Array(options[:module]).each do |m|
+      if @options[:module]
+        Array(@options[:module]).each do |m|
           extend m.is_a?(Module) ? m : "#{self.class}::#{m}".constantize
         end
       end

data/lib/shreddies/version.rb

@@ -1,3 +1,3 @@
 module Shreddies
-  VERSION = "0.4.0"
+  VERSION = "0.7.1"
 end

data/shreddies.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Stupid simple Rails model and object serializer'
   spec.homepage      = 'https://github.com/joelmoss/shreddies'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shreddies
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Joel Moss
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-description: 
+description:
 email:
 - joel@developwithstyle.com
 executables: []
@@ -69,7 +69,7 @@ metadata:
   homepage_uri: https://github.com/joelmoss/shreddies
   source_code_uri: https://github.com/joelmoss/shreddies
   changelog_uri: https://github.com/joelmoss/shreddies/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -77,15 +77,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Stupid simple Rails model and object serializer
 test_files: []