snfoil-controller 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd05e7dcc970820561431b9d85d19a5fd3420d00bc726b80adb26fdd01248d5b
-  data.tar.gz: 6f7a84286eedb8bbf29efae538192239df2f2ca96d6aa3ae7ed7ee8e1f1703ff
+  metadata.gz: c972e74246450b38ea6f71e0acb425565f85d5a4f2304a6832246b79eb0e0313
+  data.tar.gz: 4d048b56d294d390bd8c3dd71e5f3a52dafacc2e3392b51aa29e0eb788c43ba4
 SHA512:
-  metadata.gz: '08be4e5d500fbaa0b2ee35b8937aac5e6ab427c20df897272241679c24c2eb0a5e3172c38c25c6d3e53c195584a3520764f6814d89d1fa1d350690f263b46a76'
-  data.tar.gz: 80e7866dcc05d23c35740ccb0eb8776a5e9828ccf63c329f574df40c87665e4469a1c8df6aebc34ed968f7ab7b9614337e99e34e0a0641de5ff8e37ba2ab9ce8
+  metadata.gz: 5669ecd96671cefc89e5ba4bd17d77a803ef87354a0517465f44f0a693b0a2272df77901a2107da0e1d7d25d2c14cf8b82703a32e7d934e92946877cabca9888
+  data.tar.gz: a04525d6fa57c7e4b7c75c23dd7a7d18f121e23aec90927d16924a3b92b40864ebaca553c77cb5f535c69a8541640c8351d5e31f8fb0fc4bf5482960111fbbef

data/README.md

@@ -208,6 +208,18 @@ end
   </tbody>
 </table>
 
+You can directly call the context using the `#run_context` method and pass it the options.  It will automatically process either the `:context_action` or the `:controller_action` from the options.  This can be overridden by passing a method name to `#run_context`.
+
+```ruby
+...
+  context PeopleContext
+
+  def some_method(**options)
+    run_context(:elevate, **options) #=> Calls PeopleContext#elevate
+  end
+...
+```
+
 #### Serializer
 
 The main serializer intended to be called by the Controller.  Also the default serializer and block used by the '#serialize` method.
@@ -518,6 +530,36 @@ has_many :pets
   </tbody>
 </table>
 
+### JSON Deserializer
+
+##### Attrbute - Namespace
+
+The JSON Deserializer has attribute namespacing that isn't available in JSONAPI due to its structured nature.  
+
+- `namespace` an array of the nested keys needed to access a value
+
+This works with both `attribute` and `attributes`.
+
+
+```ruby
+attribute :rank, namespace: [:military_information]
+```
+
+Which would pull a nested field like in the following example.
+
+```json
+{
+  "name":"John",
+  ...
+  "military-info": {
+    "branch":"Army",
+    "rank":"Private First Class"
+  }
+  ...
+}
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/snfoil/controller/version.rb

@@ -16,6 +16,6 @@
 
 module SnFoil
   module Controller
-    VERSION = '1.0.0'
+    VERSION = '1.1.1'
   end
 end

data/lib/snfoil/controller.rb

@@ -103,8 +103,10 @@ module SnFoil
       exec_deserialize(deserializer, params, **options)
     end
 
-    def run_context(context: nil, context_action: nil, controller_action: nil, **_options)
-      (context || self.class.snfoil_context).new(entity).send(context_action || controller_action)
+    def run_context(method = nil, **options)
+      (options[:context] || self.class.snfoil_context)
+        .new(entity: entity)
+        .send(method || options[:context_action] || options[:controller_action], **options)
     end
 
     protected

data/lib/snfoil/deserializer/base.rb

@@ -75,17 +75,6 @@ module SnFoil
           @data = normalize_keys(input)
           @config = config
         end
-
-        def parse
-          raise '#parse not implemented'
-        end
-
-        def to_hash
-          parse
-        end
-
-        alias_method :to_hash, :parse
-        alias_method :to_h, :parse
       end
 
       protected

data/lib/snfoil/deserializer/json.rb

@@ -35,6 +35,13 @@ module SnFoil
           apply_transforms({}, data)
         end
 
+        def to_hash
+          parse
+        end
+
+        alias_method :to_hash, :parse
+        alias_method :to_h, :parse
+
         protected
 
         def apply_transforms(output, input)
@@ -86,9 +93,17 @@ module SnFoil
           elsif with
             send(with, input, key, **options)
           else
-            value_key = options.fetch(:key) { key }
-            value_key = "#{options[:prefix]}#{key}".to_sym if options[:prefix]
+            find_by_key(input, key, **options)
+          end
+        end
+
+        def find_by_key(input, key, **options)
+          value_key = options.fetch(:key) { key }
+          value_key = "#{options[:prefix]}#{key}".to_sym if options[:prefix]
 
+          if options[:namespace]
+            input.dig(*options[:namespace], value_key.to_sym)
+          else
             input[value_key.to_sym]
           end
         end

data/lib/snfoil/deserializer/jsonapi.rb

@@ -31,15 +31,20 @@ module SnFoil
       included do # rubocop:disable Metrics/BlockLength reason: These methods need to be in included to be overridable
         include SnFoil::Deserializer::JSON
 
-        module_eval do
-          def parse
-            input = data[:data] || data
-            return apply_transforms(data_id({}, input), input) unless input.is_a? Array
+        def parse
+          input = data[:data] || data
+          return apply_transforms(data_id({}, input), input) unless input.is_a? Array
 
-            input.map { |d| apply_transforms(data_id({}, d), d) }
-          end
+          input.map { |d| apply_transforms(data_id({}, d), d) }
+        end
+
+        def to_hash
+          parse
         end
 
+        alias_method :to_hash, :parse
+        alias_method :to_h, :parse
+
         def included
           @included ||= config[:included] || data[:included]
         end

data/snfoil-controller.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'A context-like experience for your controllers'
   spec.homepage      = 'https://github.com/limited-effort/snfoil-controller'
   spec.license       = 'Apache-2.0'
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 2.6'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 5.2.6'
   spec.add_dependency 'jsonapi-serializer', '~> 2.2'
-  spec.add_dependency 'snfoil-context', '~> 1.0'
+  spec.add_dependency 'snfoil-context', '>= 1.0.1', '< 2.0'
 
   spec.add_development_dependency 'bundle-audit', '~> 0.1.0'
   spec.add_development_dependency 'fasterer', '~> 0.10.0'
@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug', '~> 3.9'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '1.29'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.11'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.5'
+  spec.add_development_dependency 'rubocop', '1.33'
+  spec.add_development_dependency 'rubocop-performance', '1.14.3'
+  spec.add_development_dependency 'rubocop-rspec', '2.12.1'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: snfoil-controller
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Matthew Howes
 - Cliff Campbell
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,16 +43,22 @@ dependencies:
   name: snfoil-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundle-audit
   requirement: !ruby/object:Gem::Requirement
@@ -143,42 +149,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '1.29'
+        version: '1.33'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '1.29'
+        version: '1.33'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.14.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.14.3
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: 2.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: 2.12.1
 description: A context-like experience for your controllers
 email:
 - howeszy@gmail.com
@@ -206,7 +212,7 @@ metadata:
   source_code_uri: https://github.com/limited-effort/snfoil-controller
   changelog_uri: https://github.com/limited-effort/snfoil-controller/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -214,7 +220,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -222,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Seperate Display Logic from Business Logic
 test_files: []