props_template 0.22.4 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1775b28ee0009735bc63ccb79aa1b22ad397c07682699ac384568ccec3704be
-  data.tar.gz: 286f275535b658c80a2f5e8bb965a7cdeb21ef559ecfb7096447180422d4e1fd
+  metadata.gz: cb11a454a1e500ed9621d34fbe8de5ace212f85997e182ca77c934f42d2ae27e
+  data.tar.gz: 037ae1fa177ff7c6e50d80ae46a963f70dec15b028c4a46941401c3f4489dfed
 SHA512:
-  metadata.gz: ac6ac10322e53936d8535f0a89c82d4dac4894932f4ac2739bc1f68f1faddea2a7ca81d7c65bbf04dccd49991ce9c26908676157b42e5ade62dee7faed89aa22
-  data.tar.gz: 5227b5b577af671e582bfc3e27b64c9e45c90bec592238833fbb7312cb54b370db748c6ed502d4389179b7d617cf31789c00719330958a4c95435f9b3824233a
+  metadata.gz: acb7e89f553db08953ee7544590dae0c516f21fe4943a6012d77c0c63d865e98fd4926dfda597f3cf17d128f04fa163269dc6e046d884bc24d4f52bd28333758
+  data.tar.gz: 5a7262526a5dbc19c28ec7235f72ec557acd9a95ba27fcf955a7d6beb08107ec6ea999cbb9e0d247de7b3640cfe94e41b6523059ae6748da3283feca10b005dc

data/README.md

@@ -29,7 +29,7 @@ conveniences and magic.
 json.flash flash.to_h
 
 json.menu do
-  # all keys will be formatted as camelCase
+  # By default, all keys will be formatted as camelCase. See #change_key_format
 
   json.current_user do
     json.email current_user.email
@@ -94,7 +94,8 @@ You can also add a [layout](#layouts).
 
 ### json.set! or json.\<your key here\>
 
-Defines the attribute or structure. All keys are automatically camelized lower.
+Defines the attribute or structure. All keys are automatically camelized lower
+by default. See [Change Key Format](#change-key-format) to change this behavior.
 
 ```ruby
 json.set! :author_details, {...options} do
@@ -584,6 +585,23 @@ json.flash flash.to_h
 **NOTE** PropsTemplate inverts the usual Rails rendering flow. PropsTemplate
 will render Layout first, then the template when `yield json` is used.
 
+## Change key format
+By default, all keys will be formatted with `camelized(:lower)`. If you want to
+change this behavior, override it in an initializer:
+
+```ruby
+Props::BaseWithExtensions.class_eval do
+  def key_format(key)
+    key.to_s
+  end
+end
+```
+
+## Escape mode
+
+PropsTemplate runs OJ with `mode: :rails`, which escapes HTML and XML characters
+such as `&` and `<`.
+
 ## Contributing
 
 See the [CONTRIBUTING] document. Thank you, [contributors]!
@@ -593,7 +611,9 @@ See the [CONTRIBUTING] document. Thank you, [contributors]!
 
 ## Special Thanks
 
-Thanks to [turbostreamer](https://github.com/malomalo/turbostreamer) for the
-inspiration.
+Thanks to [turbostreamer], [oj], and [jbuilder] for the inspiration.
 
 [1]: https://github.com/thoughtbot/superglue
+[turbostreamer]: https://github.com/malomalo/turbostreamer
+[jbuilder]: https://github.com/rails/jbuilder
+[oj]: https://github.com/ohler55/oj/

data/lib/props_template/base.rb

@@ -1,9 +1,9 @@
-require 'oj'
-require 'active_support'
-#todo: active_support/core_ext/string/output_safety.rb
+require "oj"
+require "active_support"
 
 module Props
   class InvalidScopeForArrayError < StandardError; end
+
   class InvalidScopeForObjError < StandardError; end
 
   class Base
@@ -35,7 +35,7 @@ module Props
 
     def set!(key, value = nil)
       if @scope == :array
-        raise InvalidScopeForObjError.new('Attempted to set! on an array! scope')
+        raise InvalidScopeForObjError.new("Attempted to set! on an array! scope")
       end
 
       if @scope.nil?
@@ -81,19 +81,19 @@ module Props
       collection.each_with_index do |item, index|
         pass_opts = all_opts[index]
         handle_collection_item(collection, item, index, pass_opts) do
-          #todo: remove index?
+          # todo: remove index?
           yield item, index
         end
       end
     end
 
-    #todo, add ability to define contents of array
+    # todo, add ability to define contents of array
     def array!(collection, options = {})
       if @scope.nil?
         @scope = :array
         @stream.push_array
       else
-        raise InvalidScopeForArrayError.new('array! expects exclusive use of this block')
+        raise InvalidScopeForArrayError.new("array! expects exclusive use of this block")
       end
 
       handle_collection(collection, options) do |item, index|
@@ -108,10 +108,8 @@ module Props
     def result!
       if @scope.nil?
         @stream.push_object
-        @stream.pop
-      else
-        @stream.pop
       end
+      @stream.pop
 
       json = @stream.raw_json
       @stream.reset

data/lib/props_template/base_with_extensions.rb

@@ -5,7 +5,7 @@ module Props
     def initialize(builder, context = nil, options = {})
       @context = context
       @builder = builder
-      #todo: refactor so deferred can be its own class
+      # todo: refactor so deferred can be its own class
       @em = ExtensionManager.new(self)
       @traveled_path = []
       @key_cache = {}
@@ -50,7 +50,7 @@ module Props
     end
 
     def set!(key, options = {}, &block)
-      if block_given?
+      if block
         options = @em.refine_options(options)
       end
 
@@ -60,7 +60,7 @@ module Props
     def handle_set_block(key, options)
       @traveled_path.push(key)
       n = 1
-      if suffix = options[:path_suffix]
+      if (suffix = options[:path_suffix])
         n += suffix.length
         @traveled_path.push(suffix)
       end
@@ -68,7 +68,7 @@ module Props
       super
 
       @traveled_path.pop(n)
-      return
+      nil
     end
 
     def handle_collection_item(collection, item, index, options)
@@ -80,14 +80,14 @@ module Props
         if id.nil?
           @traveled_path.push(index)
         else
-          @traveled_path.push("#{id.to_s}=#{val}")
+          @traveled_path.push("#{id}=#{val}")
         end
       end
 
       super
 
       @traveled_path.pop
-      return
+      nil
     end
 
     def refine_all_item_options(all_options)
@@ -97,7 +97,7 @@ module Props
     def refine_item_options(item, options)
       return options if options.empty?
 
-      if key = options[:key]
+      if (key = options[:key])
         val = if item.respond_to? key
           item.send(key)
         elsif item.is_a? Hash
@@ -111,4 +111,3 @@ module Props
     end
   end
 end
-

data/lib/props_template/core_ext.rb

@@ -7,7 +7,7 @@ module Props
         end
 
         def member_by(attribute, value)
-          raise NotImplementedError, 'Implement member_by(attr, value) in your own delegate'
+          raise NotImplementedError, "Implement member_by(attr, value) in your own delegate"
         end
       end
     end

data/lib/props_template/dependency_tracker.rb

@@ -1,16 +1,15 @@
 # This was taken from jbuilder
-require 'props_template'
-
+require "props_template"
 
 dependency_tracker = false
 
 begin
-  require 'action_view'
-  require 'action_view/dependency_tracker'
+  require "action_view"
+  require "action_view/dependency_tracker"
   dependency_tracker = ::ActionView::DependencyTracker
 rescue LoadError
   begin
-    require 'cache_digests'
+    require "cache_digests"
     dependency_tracker = ::CacheDigests::DependencyTracker
   rescue LoadError
   end

data/lib/props_template/extension_manager.rb

@@ -2,7 +2,7 @@ module Props
   class ExtensionManager
     attr_reader :base, :builder, :context
 
-    def initialize(base, defered=[], fragments=[])
+    def initialize(base, defered = [], fragments = [])
       @base = base
       @context = base.context
       @builder = base.builder
@@ -15,16 +15,14 @@ module Props
     def refine_options(options, item = nil)
       options = @partialer.refine_options(options, item)
       options = @deferment.refine_options(options, item)
-      options = Cache.refine_options(options, item)
-      options
+      Cache.refine_options(options, item)
     end
 
     def refine_all_item_options(all_options)
       return all_options if all_options.empty?
 
       all_options = @partialer.find_and_add_template(all_options)
-      all_options = @cache.multi_fetch_and_add_results(all_options)
-      all_options
+      @cache.multi_fetch_and_add_results(all_options)
     end
 
     def deferred
@@ -79,10 +77,10 @@ module Props
             yield
             meta = Oj.dump([deferred_paths, fragment_paths]).strip
             json_in_progress = base.stream.to_s
-            if json_in_progress[start] == ','
+            if json_in_progress[start] == ","
               start += 1
             end
-            raw = base.stream.to_s[start..-1].strip
+            raw = base.stream.to_s[start..].strip
             result = "#{meta}\n#{raw}"
           }
           result

data/lib/props_template/extensions/cache.rb

@@ -21,9 +21,7 @@ module Props
       @context = context
     end
 
-    def context
-      @context
-    end
+    attr_reader :context
 
     def multi_fetch(keys, options = {})
       result = {}
@@ -38,12 +36,12 @@ module Props
 
       payload = {
         controller_name: controller.controller_name,
-        action_name: controller.action_name,
+        action_name: controller.action_name
       }
 
       read_caches = {}
 
-      ActiveSupport::Notifications.instrument('read_multi_fragments.action_view', payload) do |payload|
+      ActiveSupport::Notifications.instrument("read_multi_fragments.action_view", payload) do |payload|
         read_caches = ::Rails.cache.read_multi(*ckeys, options)
         payload[:read_caches] = read_caches
       end
@@ -60,31 +58,30 @@ module Props
       first_opts = all_options[0]
 
       if first_opts[:cache] && controller.perform_caching
-        keys = all_options.map{|i| i[:cache][0]}
+        keys = all_options.map { |i| i[:cache][0] }
         c_opts = first_opts[:cache][1]
         result = multi_fetch(keys, c_opts)
 
         all_options.map do |opts|
-          key =  opts[:cache][0]
+          key = opts[:cache][0]
 
           if result.key? key
             opts[:cache][1][:result] = result[key]
-            opts
-          else
-            opts
           end
+
+          opts
         end
       else
         all_options
       end
     end
 
-    #Copied from jbuilder
+    # Copied from jbuilder
     #
 
-    def cache(key=nil, options={})
+    def cache(key = nil, options = {})
       if controller.perform_caching
-        value = cache_fragment_for(key, options) do
+        cache_fragment_for(key, options) do
           yield
         end
       else
@@ -120,12 +117,11 @@ module Props
 
       if @context.respond_to?(:combined_fragment_cache_key)
         key = @context.combined_fragment_cache_key(key)
-      else
-        key = url_for(key).split('://', 2).last if ::Hash === key
+      elsif ::Hash === key
+        key = url_for(key).split("://", 2).last
       end
 
       ::ActiveSupport::Cache.expand_cache_key(key, :props)
     end
   end
 end
-

data/lib/props_template/extensions/deferment.rb

@@ -17,7 +17,7 @@ module Props
       }
 
       if item
-        type = Proc === type ? type.call(item) : type
+        type = (Proc === type) ? type.call(item) : type
       end
 
       if type
@@ -44,10 +44,10 @@ module Props
       end
 
       request_path = @base.context.controller.request.fullpath
-      path = @base.traveled_path.join('.')
+      path = @base.traveled_path.join(".")
       uri = ::URI.parse(request_path)
-      qry = ::URI.decode_www_form(uri.query || '')
-        .reject{|x| x[0] == 'props_at' }
+      qry = ::URI.decode_www_form(uri.query || "")
+        .reject { |x| x[0] == "props_at" }
         .push(["props_at", path])
 
       uri.query = ::URI.encode_www_form(qry)
@@ -55,7 +55,7 @@ module Props
       deferral = {
         url: uri.to_s,
         path: path,
-        type: type.to_s,
+        type: type.to_s
       }
 
       # camelize for JS land

data/lib/props_template/extensions/fragment.rb

@@ -2,7 +2,7 @@ module Props
   class Fragment
     attr_reader :fragments
 
-    def initialize(base, fragments=[])
+    def initialize(base, fragments = [])
       @base = base
       @fragments = fragments
     end
@@ -14,11 +14,11 @@ module Props
 
       if String === fragment || Symbol === fragment
         fragment_name = fragment.to_s
-        path = @base.traveled_path.join('.')
+        path = @base.traveled_path.join(".")
         @name = fragment_name
 
         @fragments.push(
-          { type: fragment_name, partial: partial_name, path: path }
+          {type: fragment_name, partial: partial_name, path: path}
         )
       end
     end

data/lib/props_template/extensions/partial_renderer.rb

@@ -1,4 +1,4 @@
-require 'action_view'
+require "action_view"
 
 module Props
   class RenderedTemplate
@@ -23,7 +23,6 @@ module Props
     IDENTIFIER_ERROR_MESSAGE = "The partial name (%s) is not a valid Ruby identifier; " \
                                "make sure your partial name starts with underscore."
 
-
     def initialize(base, context, builder)
       @context = context
       @builder = builder
@@ -67,7 +66,7 @@ module Props
       template_keys = retrieve_template_keys(partial_opts)
       details = extract_details(partial_opts)
 
-      prefixes = partial.include?(?/) ? [] : @context.lookup_context.prefixes
+      prefixes = partial.include?("/") ? [] : @context.lookup_context.prefixes
       @context.lookup_context.find_template(partial, prefixes, true, template_keys, details)
     end
 
@@ -81,13 +80,12 @@ module Props
       partial, pass_opts = [*options[:partial]]
       pass_opts ||= {}
       pass_opts[:locals] ||= {}
-      pass_opts[:locals][:json] = @builder
       pass_opts[:partial] = partial
       pass_opts[:formats] = [:json]
       pass_opts.delete(:handlers)
 
       if !(String === partial)
-        raise ArgumentError.new(INVALID_PARTIAL_MESSAGE % (partial.inspect))
+        raise ArgumentError.new(INVALID_PARTIAL_MESSAGE % partial.inspect)
       end
 
       pass_opts
@@ -121,15 +119,15 @@ module Props
     end
 
     def raise_invalid_option_as(as)
-      raise ArgumentError.new(OPTION_AS_ERROR_MESSAGE % (as))
+      raise ArgumentError.new(OPTION_AS_ERROR_MESSAGE % as)
     end
 
     def raise_invalid_identifier(path)
-      raise ArgumentError.new(IDENTIFIER_ERROR_MESSAGE % (path))
+      raise ArgumentError.new(IDENTIFIER_ERROR_MESSAGE % path)
     end
 
     def retrieve_variable(path)
-      base = path[-1] == "/" ? "" : File.basename(path)
+      base = (path[-1] == "/") ? "" : File.basename(path)
       raise_invalid_identifier(path) unless base =~ /\A_?(.*?)(?:\.\w+)*\z/
       $1.to_sym
     end
@@ -153,7 +151,7 @@ module Props
 
         locals[as] = item
 
-        if fragment_name = rest[:fragment]
+        if (fragment_name = rest[:fragment])
           rest[:fragment] = fragment_name.to_s
         end
       end

data/lib/props_template/handler.rb

@@ -1,4 +1,4 @@
-require 'active_support'
+require "active_support"
 
 module Props
   class Handler
@@ -8,8 +8,8 @@ module Props
     def self.call(template, source = nil)
       source ||= template.source
       # this juggling is required to keep line numbers right in the error
-      %{__already_defined = defined?(json); json||=Props::Template.new(self); #{source};
-        json.result! unless (__already_defined && __already_defined != "method")
+      %{ __finalize = !defined?(@__json); @__json ||= Props::Template.new(self); json = @__json; #{source};
+        json.result! if __finalize
       }
     end
   end

data/lib/props_template/layout_patch.rb

@@ -1,54 +1,29 @@
 module Props
   module LayoutPatch
-    def render(context, options)
-      options[:locals] ||= {}
-      options[:locals][:json] = nil
-
-      @details = extract_details(options)
-      template = determine_template(options)
-
-      if template.respond_to?(:handler) && template.handler == Props::Handler && options[:layout]
+    def render_template(view, template, layout_name, locals)
+      if template.respond_to?(:handler) && template.handler == Props::Handler && layout_name
         prepend_formats(template.format)
-        render_props_template(context, template, options[:layout], options[:locals])
+        render_props_template(view, template, layout_name, locals)
       else
-        super(context, options)
+        super
       end
     end
 
     def render_props_template(view, template, path, locals)
       layout_locals = locals.dup
-      layout_locals.delete(:json)
       layout_locals[:virtual_path_of_template] = template.virtual_path
 
-      layout = resolve_props_layout(path, layout_locals.keys, [formats.first])
-      body = layout.render(view, layout_locals) do |json|
-        locals[:json] = json
+      layout = resolve_layout(path, layout_locals.keys, [formats.first])
+      body = if layout
+        layout.render(view, layout_locals) do |json|
+          template.render(view, locals)
+        end
+      else
         template.render(view, locals)
       end
 
       build_rendered_template(body, template)
     end
-
-    def resolve_props_layout(layout, keys, formats)
-      details = @details.dup
-      details[:formats] = formats
-
-      case layout
-      when String
-        begin
-          if layout.start_with?("/")
-            ActiveSupport::Deprecation.warn "Rendering layouts from an absolute path is deprecated."
-            @lookup_context.with_fallbacks.find_template(layout, nil, false, [], details)
-          else
-            @lookup_context.find_template(layout, nil, false, [], details)
-          end
-        end
-      when Proc
-        resolve_layout(layout.call(@lookup_context, formats), keys, formats)
-      else
-        layout
-      end
-    end
   end
 end
 

data/lib/props_template/railtie.rb

@@ -1,13 +1,13 @@
-require 'rails/railtie'
-require 'props_template'
+require "rails/railtie"
+require "props_template"
 
 module Props
   class Railtie < ::Rails::Railtie
     initializer :props_template do
       ActiveSupport.on_load :action_view do
         ActionView::Template.register_template_handler :props, Props::Handler
-        require 'props_template/dependency_tracker'
-        require 'props_template/layout_patch'
+        require "props_template/dependency_tracker"
+        require "props_template/layout_patch"
       end
     end
   end

data/lib/props_template/searcher.rb

@@ -2,7 +2,7 @@ module Props
   class Searcher
     attr_reader :builder, :context, :fragments, :traveled_path
 
-    def initialize(builder, path=[], context = nil)
+    def initialize(builder, path = [], context = nil)
       @search_path = path
       @depth = 0
       @context = context
@@ -24,7 +24,7 @@ module Props
     def found!
       pass_opts = @found_options.clone || {}
       pass_opts.delete(:defer)
-      traveled_path = @traveled_path[1..-1] || []
+      traveled_path = @traveled_path[1..] || []
       if !traveled_path.empty?
         pass_opts[:path_suffix] = traveled_path
       end
@@ -36,8 +36,8 @@ module Props
       yield
     end
 
-    def set!(key, options={}, &block)
-      return if @found_block || !block_given?
+    def set!(key, options = {}, &block)
+      return if @found_block || !block
 
       if @search_path[@depth] == key.to_s
         @traveled_path.push(key)
@@ -64,7 +64,7 @@ module Props
       return if @found_block
 
       key_index = @search_path[@depth]
-      id_name, id_val = key_index.to_s.split('=')
+      id_name, id_val = key_index.to_s.split("=")
 
       if id_val
         id_val = id_val.to_i
@@ -80,7 +80,7 @@ module Props
 
         if @depth == @search_path.size - 1
           @found_options = pass_opts
-          @found_block = Proc.new {
+          @found_block = proc {
             yield item, 0
           }
           return

data/lib/props_template/version.rb

@@ -1,3 +1,3 @@
 module Props
-  VERSION = "0.22.4".freeze
+  VERSION = "0.23.0".freeze
 end

data/lib/props_template.rb

@@ -1,17 +1,17 @@
-require 'props_template/base'
-require 'props_template/extensions/partial_renderer'
-require 'props_template/extensions/cache'
-require 'props_template/extensions/deferment'
-require 'props_template/extensions/fragment'
-require 'props_template/base_with_extensions'
-require 'props_template/extension_manager'
-require 'active_support/core_ext/string/output_safety'
-require 'active_support/core_ext/array'
-require 'props_template/searcher'
-require 'props_template/handler'
-require 'props_template/version'
-
-require 'active_support'
+require "props_template/base"
+require "props_template/extensions/partial_renderer"
+require "props_template/extensions/cache"
+require "props_template/extensions/deferment"
+require "props_template/extensions/fragment"
+require "props_template/base_with_extensions"
+require "props_template/extension_manager"
+require "active_support/core_ext/string/output_safety"
+require "active_support/core_ext/array"
+require "props_template/searcher"
+require "props_template/handler"
+require "props_template/version"
+
+require "active_support"
 
 module Props
   class Template
@@ -19,7 +19,7 @@ module Props
       attr_accessor :template_lookup_options
     end
 
-    self.template_lookup_options = { handlers: [:props] }
+    self.template_lookup_options = {handlers: [:props]}
 
     delegate :result!, :array!,
       :deferred!,
@@ -34,7 +34,7 @@ module Props
     end
 
     def set!(key, options = {}, &block)
-      if block_given? && options[:search] && !@builder.is_a?(Searcher)
+      if block && options[:search] && !@builder.is_a?(Searcher)
 
         prev_builder = @builder
         @builder = Searcher.new(self, options[:search], @context)
@@ -60,4 +60,4 @@ module Props
   end
 end
 
-require 'props_template/railtie' if defined?(Rails)
+require "props_template/railtie" if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 0.22.4
+  version: 0.23.0
 platform: ruby
 authors:
 - Johny Ho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -65,7 +65,6 @@ files:
 - lib/props_template/base.rb
 - lib/props_template/base_with_extensions.rb
 - lib/props_template/core_ext.rb
-- lib/props_template/debug_writer.rb
 - lib/props_template/dependency_tracker.rb
 - lib/props_template/extension_manager.rb
 - lib/props_template/extensions/cache.rb
@@ -77,9 +76,6 @@ files:
 - lib/props_template/railtie.rb
 - lib/props_template/searcher.rb
 - lib/props_template/version.rb
-- spec/layout_spec.rb
-- spec/props_template_spec.rb
-- spec/searcher_spec.rb
 homepage: https://github.com/thoughtbot/props_template/
 licenses:
 - MIT
@@ -103,7 +99,4 @@ rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A fast JSON builder
-test_files:
-- spec/searcher_spec.rb
-- spec/layout_spec.rb
-- spec/props_template_spec.rb
+test_files: []

data/lib/props_template/debug_writer.rb

@@ -1,55 +0,0 @@
-require 'oj'
-require 'active_support'
-require 'byebug'
-
-module Props
-  class DebugWriter
-    attr_accessor :commands
-
-    def initialize(opts)
-      @stream = Oj::StringWriter.new(opts)
-      @commands = []
-    end
-
-    def push_object
-      @commands.push([:push_object])
-    end
-
-    def push_key(key)
-      @commands.push([:push_key, key])
-    end
-
-    def push_value(value, key = nil)
-      if key
-        @commands.push([:push_value, value, key])
-      else
-        @commands.push([:push_value, value])
-      end
-    end
-
-    def push_array
-      @commands.push([:push_array])
-    end
-
-    def pop
-      @commands.push([:pop])
-    end
-
-    def reset
-      @commands = []
-      @stream.reset
-    end
-
-    def to_s
-      @commands.each do |command|
-        begin
-          @stream.send(*command)
-        rescue => e
-          byebug
-        end
-      end
-
-      @stream.to_s
-    end
-  end
-end

data/spec/layout_spec.rb

@@ -1,24 +0,0 @@
-require_relative "./support/helper"
-require_relative "./support/rails_helper"
-require "props_template/layout_patch"
-require "action_controller"
-
-RSpec.describe "Props::Template" do
-  class TestController < ActionController::Base
-    protect_from_forgery
-
-    def self.controller_path
-      ""
-    end
-  end
-
-  it "uses a layout to render" do
-    view_path = File.join(File.dirname(__FILE__), "./fixtures")
-    controller = TestController.new
-    controller.prepend_view_path(view_path)
-
-    json = controller.render_to_string("200", layout: "application")
-
-    expect(json.strip).to eql('{"data":{"success":"ok"}}')
-  end
-end

data/spec/props_template_spec.rb

@@ -1,300 +0,0 @@
-require_relative './support/helper'
-
-RSpec.describe 'Props::Base' do
-  it 'initializes' do
-    expect {
-      Props::Base.new
-    }.to_not raise_error
-  end
-
-  context 'result!' do
-    it 'returns {} when empty' do
-      json = Props::Base.new
-      expect(json.result!.strip).to eql('{}')
-    end
-
-    it 'resets OJ' do
-      json = Props::Base.new
-      json.set! :foo, 'bar'
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json({
-        foo: 'bar'
-      })
-
-      expect(json.result!.strip).to eql_json({})
-
-      json.set! :foo, 'bar'
-      attrs = json.result!.strip
-      expect(attrs).to eql_json({
-        foo: 'bar'
-      })
-    end
-  end
-
-  context 'set!' do
-    it 'sets a value' do
-      json = Props::Base.new
-      json.set! :foo, 'bar'
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json({
-        foo: 'bar'
-      })
-    end
-
-    it 'sets a empty obj when block is empty' do
-      json = Props::Base.new
-      json.set! :foo do
-      end
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json({
-        foo: {}
-      })
-    end
-
-    it 'sets a empty obj when nested block is empty' do
-      json = Props::Base.new
-      json.set! :foo do
-        json.set! :bar do
-        end
-      end
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json({
-        foo: {
-          bar: {}
-        }
-      })
-    end
-
-    it 'sets a null value' do
-      json = Props::Base.new
-      json.set! :foo, nil
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json({
-        foo: nil
-      })
-    end
-
-    it 'sets multiple values' do
-      json = Props::Base.new
-      json.set! :foo, 'bar'
-      json.set! :steve, 'cool'
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json({
-        foo: 'bar',
-        steve: 'cool'
-      })
-    end
-
-    it 'sets multiple values with the same key, the last one wins' do
-      json = Props::Base.new
-      json.set! :foo, 'bar'
-      json.set! :foo, 'cool'
-
-      attrs = JSON.parse(json.result!)
-
-      expect(attrs).to eql({
-        'foo' => 'cool'
-      })
-    end
-
-    it 'throws InvalidScopeForObjError when the current scope is an array' do
-      json = Props::Base.new
-      json.array! [1, 2] do |item|
-        json.set! :foo, item
-      end
-      expect {
-        json.set! :bar, 'world'
-      }.to raise_error(Props::InvalidScopeForObjError)
-    end
-  end
-
-  context 'set! with a block' do
-    it 'creates a new nested object' do
-      json = Props::Base.new
-      json.set! :outer do
-        json.set! :inner, 'baz'
-      end
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json({
-        outer: {
-          inner: 'baz'
-        }
-      })
-    end
-
-    it 'creates a nested object' do
-      json = Props::Base.new
-      json.set! :outer do
-        json.set! :inner, 'baz'
-      end
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json({
-        outer: {
-          inner: 'baz'
-        }
-      })
-    end
-
-    it 'creates a nested array of objects' do
-      json = Props::Base.new
-      json.set! :outer do
-        json.array! [1, 2] do |item|
-          json.set! :foo, item
-        end
-      end
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json({
-        outer: [
-          {foo: 1},
-          {foo: 2}
-        ]
-      })
-    end
-
-    it 'treats the second argument as an options arg' do
-      json = Props::Base.new
-      json.set! :outer, {some: 'setting'} do
-        json.set! :inner, 'baz'
-      end
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json({
-        outer: {
-          inner: 'baz'
-        }
-      })
-    end
-  end
-
-  context 'array!' do
-    it 'creates an array of 1 object' do
-      json = Props::Base.new
-      json.array! [1] do |num|
-        json.set! :foo, num
-      end
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json([
-        {foo: 1}
-      ])
-    end
-
-    it 'passes the index as the second argument of yield' do
-      json = Props::Base.new
-      json.array! ['a', 'b'] do |item, index|
-        json.set! :foo, [item, index]
-      end
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json([
-        {foo: ['a', 0]},
-        {foo: ['b', 1]}
-      ])
-    end
-
-    it 'creates an empty array when passed an empty collection' do
-      json = Props::Base.new
-      json.array! [] do |num|
-      end
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json([
-      ])
-    end
-
-    it 'creates an array of empty arrays when passed an empty collection' do
-      json = Props::Base.new
-      json.array! [1] do |num|
-        json.array! [] do
-        end
-      end
-
-      attrs = json.result!.strip
-      expect(attrs).to eql_json([[]])
-    end
-
-    it 'creates an array of empties if set did not get called in array' do
-      json = Props::Base.new
-      json.array! [1, 2, 3] do |num|
-      end
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json([
-        {},
-        {},
-        {}
-      ])
-    end
-
-    it 'throws InvalidScopeForArray error when array is used twice' do
-      json = Props::Base.new
-      json.array! [1] do
-        json.set! :foo, 'first'
-      end
-
-      expect {
-        json.array! [2] do |num|
-          json.set! :foo, 'second'
-        end
-      }.to raise_error(Props::InvalidScopeForArrayError)
-    end
-
-    it 'creates an array of multiple objects' do
-      json = Props::Base.new
-      json.array! [1, 2] do |num|
-        json.set! :foo, num
-      end
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json([
-        {foo: 1},
-        {foo: 2}
-      ])
-    end
-
-    it 'creates an array of arrays' do
-      json = Props::Base.new
-      json.array! [[1, 2], [3, 4]] do |part|
-        json.array! part do |num|
-          json.set! :foo, num
-        end
-      end
-
-      attrs = json.result!.strip
-
-      expect(attrs).to eql_json([
-        [{foo: 1}, {foo: 2}],
-        [{foo: 3}, {foo: 4}]
-      ])
-    end
-
-    it 'throws InvalidScopeForArrayError when the current scope is already an object' do
-      json = Props::Base.new
-      json.set! :foo, 'bar'
-      expect {
-        json.array! [1, 2] do |num|
-          json.set! :foo, 'noop'
-        end
-      }.to raise_error(Props::InvalidScopeForArrayError)
-    end
-  end
-end

data/spec/searcher_spec.rb

@@ -1,209 +0,0 @@
-require_relative './support/helper'
-
-RSpec.describe 'Searcher' do
-  it 'searching for a child node returns the proc, and refined found options' do
-    json = Props::Searcher.new(nil, ['outer', 'inner', 'hit'])
-    target_proc = Proc.new {}
-    target_opts = {some_options: 1}
-    json.set!('outer') do
-      json.set!('inner') do
-        json.set!('hit', target_opts, &target_proc)
-      end
-    end
-
-    found_block, found_options = json.found!
-    expect(found_block).to eql(target_proc)
-    expect(found_options).to eql({
-      some_options: 1,
-      path_suffix: ['inner', 'hit']
-    })
-  end
-
-  it 'searching with an empty path means you found nothing' do
-    json = Props::Searcher.new(nil, [])
-
-    target_proc = Proc.new do
-      json.set!('inner') do
-        json.set!('hit', {}, &target_proc)
-      end
-    end
-    json.set!('outer', {}, &target_proc)
-
-    found_block, found_options = json.found!
-    expect(found_block).to be_nil
-  end
-
-  it 'searching for a child node with siblings in back' do
-    json = Props::Searcher.new(nil, ['outer', 'inner'])
-    target_proc = Proc.new do
-      json.set!('foo', 32)
-    end
-
-    json.set!('outer') do
-      json.set!('inner', {}, &target_proc)
-
-      json.set!('bad') do
-        json.set!('foo', 'should not touch')
-      end
-    end
-
-    found_block, found_options = json.found!
-    expect(found_block).to eql(target_proc)
-  end
-
-  it 'searching for a child node with siblings in front' do
-    json = Props::Searcher.new(nil, ['outer', 'inner'])
-    target_proc = Proc.new do
-      json.foo 32
-    end
-
-    json.set!('outer') do
-      json.set!('bad') do
-        json.set!('foo', 'should not touch')
-      end
-
-      json.set!('inner', {}, &target_proc)
-    end
-
-    found_block, found_options = json.found!
-    expect(found_block).to eql(target_proc)
-  end
-
-  it 'searching for a subtree' do
-    json = Props::Searcher.new(nil, ['outer', 'inner', 'deep'])
-
-    target_proc = Proc.new do
-      json.set!('deeper') do
-        json.set!('foo', 32)
-      end
-    end
-
-    json.set!('outer') do
-      json.set!('inner') do
-        json.set!('deep', {}, &target_proc)
-      end
-    end
-
-    found_block, found_options = json.found!
-    expect(found_block).to eql(target_proc)
-  end
-
-  it 'searching for a leaf node is unsupported' do
-    json = Props::Searcher.new(nil, ['outer', 'inner', 'foo'])
-    json.set!('outer') do
-      json.set!('inner') do
-        json.set!('foo', 32)
-      end
-    end
-
-    found_block, found_options = json.found!
-    expect(found_block).to be_nil
-  end
-
-  it 'searching for a node beyond whats available is equivalent to not finding anything' do
-    json = Props::Searcher.new(nil, ['outer', 'inner', 'a', 'b'])
-    json.set!('outer') do
-      json.set!('inner') do
-        json.set!('foo', 32)
-      end
-    end
-
-    found_block, found_options = json.found!
-    expect(found_block).to be_nil
-  end
-
-  it 'searching for an item inside an array, includes refined found options' do
-    json = Props::Searcher.new(nil, ['outer', 1])
-    target_opts = {some_options: 1}
-    json.set!('outer') do
-      json.array!(['hello', 'world'], target_opts) do |item|
-        item
-      end
-    end
-
-    found_block, found_options = json.found!
-    expect(found_options).to eql({some_options: 1, path_suffix: [1]})
-    expect(found_block.call).to eql('world')
-  end
-
-  it 'searching for an item inside an array using an id=val keypath' do
-    json = Props::Searcher.new(nil, ['outer', 'id=1'])
-
-    class Collection
-      def initialize(ary, rspec)
-        @ary = ary
-        @rspec = rspec
-      end
-
-      def member_by(key, value)
-        @rspec.expect(key).to @rspec.eql('id')
-        @rspec.expect(value).to @rspec.eql(1)
-        @ary.last
-      end
-    end
-
-    collection = Collection.new(
-      [{id: 0}, {id: 1}],
-      self
-    )
-
-    json.set!('outer') do
-      json.array!(collection) do |item|
-        item
-      end
-    end
-
-    found_block, found_options = json.found!
-    expect(found_block.call).to eql({id: 1})
-  end
-
-  it 'searching for an node belonging an array' do
-    json = Props::Searcher.new(nil, ['outer', 'inner', 1, 'foo'])
-    json.set!('outer') do
-      json.set!('inner') do
-        json.array! ['hello', 'world'] do |item|
-          json.set!('foo') do
-            item
-          end
-        end
-      end
-    end
-    found_block, found_options = json.found!
-    expect(found_block.call).to eql('world')
-  end
-
-  it 'searching for an node outside the length of the array, is equivalent to not finding anything' do
-    json = Props::Searcher.new(nil, ['outer','inner', 10, 'foo'])
-    json.set!('outer') do
-      json.set!('inner') do
-        json.array! [1, 2] do |item|
-          json.set!('foo') do
-            json.set!('bar', item)
-          end
-        end
-      end
-    end
-
-    found_block, found_options = json.found!
-    expect(found_block).to be_nil
-  end
-
-  it 'searching for object inside a nested array' do
-    json = Props::Searcher.new(nil, ['outer', 'inner', 1, 'foo', 0])
-    json.set!('outer') do
-      json.set!('inner') do
-        json.array! [0, 1] do |item|
-          json.set!('foo') do
-            json.array! ['hello', 'world'] do |inner_item|
-              inner_item
-            end
-          end
-        end
-      end
-    end
-
-    found_block, found_options = json.found!
-    expect(found_block.call).to eql('hello')
-  end
-end
-