breezy_template 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 194841224366e609e53fb0321ab3dc578436f60a
-  data.tar.gz: d9122125e4b9f272f23449f1165ed2b79c4aa1b6
+  metadata.gz: 64f7958f565f036dc57e27e520c791e7b16e5f0d
+  data.tar.gz: 5d1ef989831b31f354b3d1e578a6be2cc757da3f
 SHA512:
-  metadata.gz: 118d61420698fdbed96028190d7909990be69e7b82415d7029892ad457462c6bbd1eb3da296de8979cea4ecd175f6c0148714618106761bd55c5b9c6d6df617c
-  data.tar.gz: cccf65ab229f63c4c97011194188518bc9aceb5f1c45735f22400f2e9e0609c956d3eb195d1e82a81ad9015559a68b70e898f0a50f5c529ef68d50c2b456e3bb
+  metadata.gz: ef5697134625758c22427708e99e5b8eb707b2af94414b52c98b88a3ebd98c493f8f8756306135f0df3a80ae1fc029ee2006ebccd484394538eb9ca7c6076dff
+  data.tar.gz: 939b5591aa0d9c6062228708e893d8cfa5be07252d50a280401d7044cb9df382fe20108c9fdfb65821cee1295b554e6b31d251eb9e35b31b604d1fcf89a1aa43

data/lib/breezy_template.rb

@@ -2,7 +2,6 @@ require 'breezy_template/breezy_template'
 
 require 'breezy_template/blank'
 require 'breezy_template/var'
-require 'breezy_template/key_formatter'
 require 'breezy_template/errors'
 
 require 'breezy_template/active_support'
@@ -34,7 +33,6 @@ class BreezyTemplate
 
   self.template_lookup_options = { handlers: [:breezy, :props] }
 
-  @@key_formatter = nil
   @@ignore_nil    = false
 
   def initialize(context, options = {})
@@ -44,7 +42,6 @@ class BreezyTemplate
     @joints = {}
 
     @attributes = {}
-    @key_formatter = options.fetch(:key_formatter){ @@key_formatter ? @@key_formatter.clone : nil}
     @ignore_nil = options.fetch(:ignore_nil, @@ignore_nil)
 
     yield self if ::Kernel.block_given?
@@ -106,15 +103,6 @@ class BreezyTemplate
     @path.pop
   end
 
-  def key_format!(*args)
-    @key_formatter = KeyFormatter.new(*args)
-  end
-
-  # Same as the instance method key_format! except sets the default.
-  def self.key_format(*args)
-    @@key_formatter = KeyFormatter.new(*args)
-  end
-
   def empty!
     attributes = @attributes
     @attributes = {}
@@ -135,24 +123,21 @@ class BreezyTemplate
     @attributes << _scope{ yield self }
   end
 
-
-  def array!(collection = [], *attributes)
+  def array!(collection, *attributes)
     options = attributes.first || {}
 
-    collection = [] if collection.nil?
+    if !collection.respond_to? :member_by
+      raise ::NotImplementedError, 'collection must implement member_by(attr, value)'
+    end
+
+    if !collection.respond_to? :member_at
+      raise ::NotImplementedError, 'collection must implement member_at(index)'
+    end
+
+
     collection = _prepare_collection_for_map(collection)
     array = if ::Kernel.block_given?
       _map_collection(collection, options, &::Proc.new)
-    # elsif attributes.any?
-    #   if (!attributes.last.is_a? ::Hash)
-    #     _map_collection(collection) { |element|
-    #       extract! element, *attributes
-    #     }
-    #   else
-    #     _map_collection(collection, options) { |element|
-    #       extract! element, *attributes
-    #     }
-    #   end
     else
       collection.to_a
     end
@@ -226,7 +211,7 @@ class BreezyTemplate
   end
 
   def _key(key)
-    @key_formatter ? @key_formatter.format(key) : key.to_s
+    key.to_s
   end
 
   def _set_value(key, value)
@@ -264,12 +249,12 @@ class BreezyTemplate
   end
 
   def _scope
-    parent_attributes, parent_formatter = @attributes, @key_formatter
+    parent_attributes = @attributes
     @attributes = BLANK
     yield
     @attributes
   ensure
-    @attributes, @key_formatter = parent_attributes, parent_formatter
+    @attributes = parent_attributes
   end
 
   def _is_collection?(object)

data/lib/breezy_template/core_ext.rb

@@ -0,0 +1,20 @@
+class BreezyTemplate
+  module Extensions
+    module Array
+      module Member
+        def member_at(index)
+          at(index)
+        end
+
+        def member_by(attribute, value)
+          raise NotImplementedError, 'Implement member_by(attr, value) in your own delegate'
+        end
+      end
+    end
+  end
+end
+
+class Array
+  include BreezyTemplate::Extensions::Array::Member
+end
+

data/lib/breezy_template/errors.rb

@@ -21,4 +21,11 @@ class BreezyTemplate
       new(message)
     end
   end
+
+  class NotFoundError < ::StandardError
+    def self.build(search_path)
+      message = "Could not find node at #{search_path}"
+      new(message)
+    end
+  end
 end

data/lib/breezy_template/handler.rb

@@ -9,8 +9,7 @@ class BreezyTemplate
       # this juggling is required to keep line numbers right in the error
       %{__already_defined = defined?(json); json||=::BreezyTemplate.new(self);json._filter_by_path(breezy_filter) if defined?(breezy_filter); json._set_request_url(request.path);#{template.source}
         if !(__already_defined && __already_defined != "method")
-          json.merge!({data: json.found! || json.empty! })
-          json.key_format! :downcase
+          json.merge!({data: json._found! || json.empty! })
           if defined?(breezy) && breezy
             breezy.each do |k, v|
               json.set! k, v

data/lib/breezy_template/search_extension.rb

@@ -2,10 +2,14 @@ require 'breezy_template/breezy_template'
 
 class BreezyTemplate
   module SearchExtension
-    def found!
+    def _found!
+      if !@search_path.nil? && @found.nil?
+        ::Kernel.raise NotFoundError.build(@search_path)
+      end
+
       found = @found
       @found = nil
-      @search_path = []
+      @search_path = nil
       found
     end
 
@@ -36,31 +40,15 @@ class BreezyTemplate
       if @search_path && !@search_path.empty?
         id_name, id_val = @search_path.first.split('=')
 
-        if (defined? ::ActiveRecord) && collection.is_a?(::ActiveRecord::Relation)
-          if id_val
-            id_val = id_val.to_i
-            collection = collection.where(::Hash[id_name, id_val])
-          else
-            index = id_name.to_i
-            collection = collection.offset(index).limit(1)
-          end
+        if id_val
+          id_val = id_val.to_i
+          found = collection.member_by(id_name, id_val)
         else
-          if id_val
-            id_val = id_val.to_i
-            found = collection.find do |ele|
-              ele[id_name] == id_val || ele[id_name.to_sym] == id_val
-            end
-          else
-            index = id_name.to_i
-            found = collection[index]
-          end
-
-          if found
-            collection = [found]
-          else
-            collection = []
-          end
+          index = id_name.to_i
+          found = collection.member_at(index)
         end
+
+        found ? [found] : []
       else
         super
       end

data/test/extensions_test.rb

@@ -1,6 +1,6 @@
 require "test_helper"
 require "mocha"
-
+require 'delegate'
 require "action_view"
 require "action_view/testing/resolvers"
 require "breezy_template"
@@ -106,7 +106,9 @@ class BreezyTemplateTest < ActionView::TestCase
   end
 
   def action_controller_test_request
-    if ::Rails.version.start_with?('5.1')
+    if ::Rails.version.start_with?('5.2')
+      ::ActionController::TestRequest.create({})
+    elsif ::Rails.version.start_with?('5.1')
       ::ActionController::TestRequest.create({})
     elsif ::Rails.version.start_with?('5')
       ::ActionController::TestRequest.create
@@ -263,48 +265,6 @@ class BreezyTemplateTest < ActionView::TestCase
     assert_equal expected, result
   end
 
-  test "key_format! with parameter" do
-    result = jbuild(<<-JBUILDER)
-      json.key_format! camelize: [:lower]
-      json.camel_style "for JS"
-    JBUILDER
-
-    expected = strip_format(<<-JS)
-      (function(){
-        var joints={};
-        var cache={};
-        var defers=[];
-        return ({"data":{"camelStyle":"for JS"},"joints":joints,"defers":defers});
-      })()
-    JS
-
-    assert_equal expected, result
-  end
-
-  test "key_format! propagates to child elements" do
-    result = jbuild(<<-JBUILDER)
-      json.key_format! :upcase
-      json.level1 "one"
-      json.level2 do
-        json.value "two"
-      end
-    JBUILDER
-
-    expected = strip_format(<<-JS)
-      (function(){
-        var joints={};
-        var cache={};
-        var defers=[];
-        return ({"data":{
-          "LEVEL1":"one",
-          "LEVEL2":{"VALUE":"two"}
-        },"joints":joints,"defers":defers});
-      })()
-    JS
-
-    assert_equal expected, result
-  end
-
   test "renders partial via the option through set!" do
     @post = BLOG_POST_COLLECTION.first
     Rails.cache.clear
@@ -517,9 +477,9 @@ class BreezyTemplateTest < ActionView::TestCase
     assert_equal expected, result
   end
 
-  test "renders array of partials as empty array with nil-collection" do
+  test "renders array of partials as empty array with an empty collection" do
     result = jbuild(<<-JBUILDER)
-      json.array! nil, partial: ["blog_post", as: :blog_post]
+      json.array! [], partial: ["blog_post", as: :blog_post]
     JBUILDER
 
     expected = strip_format(<<-JS)
@@ -935,6 +895,23 @@ class BreezyTemplateTest < ActionView::TestCase
     assert_equal expected, result
   end
 
+  test "filtering for a nonexistant node in the tree" do
+    begin
+      jbuild(<<-JBUILDER)
+        json._filter_by_path('miss.miss.miss.miss')
+        json.hit do
+          json.hit2 do
+            json.greeting 'hello world'
+          end
+        end
+      JBUILDER
+    rescue => e
+      assert_equal e.cause.class, BreezyTemplate::NotFoundError
+      assert_equal e.message, 'Could not find node at ["miss", "miss", "miss", "miss"]'
+    end
+
+    Rails.cache.clear
+  end
   test "filtering for a raw value is also possble" do
     result = jbuild(<<-JBUILDER, breezy_filter: 'hit.hit2')
       json.hit do
@@ -1041,84 +1018,12 @@ class BreezyTemplateTest < ActionView::TestCase
     assert_equal expected, result
   end
 
-  test "filtering for a node of a AR relation in a tree by id via an appended where clause" do
-    Post.delete_all
-    Note.delete_all
-
-    post = Post.create
-    first_note = post.notes.create(title: 'first')
-    post.notes.create(title: 'second')
-
-    result = jbuild(<<-JBUILDER, breezy_filter: "hit.hit2.id=#{first_note.id}")
-      post = Post.first
-      first_note = Note.where(title: 'first').first
-      post.notes.expects(:where).once().with('id'=>first_note.id).returns([{id: first_note.id, title: 'first'}])
-
-      json.hit do
-        json.hit2 do
-          json.array! post.notes do |x|
-            raise 'this should be be called' if x[:title] == 'second'
-            json.title x[:title]
-          end
-        end
-      end
-    JBUILDER
-
-    Rails.cache.clear
-    id = Note.where(title: 'first').first.id
-    expected = strip_format(<<-JS)
-      (function(){
-        var joints={};
-        var cache={};
-        var defers=[];
-        return (
-          {"data":{"title":"first"},"action":"graft","path":"hit.hit2.id=#{id}","joints":joints,"defers":defers}
-        );
-      })()
-    JS
-    assert_equal expected, result
-  end
-
-
-  test "filtering for a node of a AR relation in a tree by index via an appended where clause" do
-    result = jbuild(<<-JBUILDER, breezy_filter: 'hit.hit2.0')
-      post = Post.create
-      post.notes.create title: 'first'
-      post.notes.create title: 'second'
-
-      offset = post.notes.offset(0)
-      post.notes.expects(:offset).once().with(0).returns(offset)
-
-      json.hit do
-        json.hit2 do
-          json.array! post.notes do |x|
-            raise 'this should be be called' if x[:title] == 'second'
-            json.title x[:title]
-          end
-        end
-      end
-    JBUILDER
-
-    Rails.cache.clear
-
-    expected = strip_format(<<-JS)
-      (function(){
-        var joints={};
-        var cache={};
-        var defers=[];
-        return (
-          {"data":{"title":"first"},"action":"graft","path":"hit.hit2.0","joints":joints,"defers":defers}
-        );
-      })()
-    JS
-    assert_equal expected, result
-  end
-
   test "filtering for a node in an array of a tree by id" do
     result = jbuild(<<-JBUILDER, breezy_filter: 'hit.hit2.id=1')
       json.hit do
         json.hit2 do
-          json.array! [{id: 1, name: 'hit' }, {id:2, name: 'miss'}] do |x|
+          data = ObjectCollection.new([{id: 1, name: 'hit' }, {id:2, name: 'miss'}])
+          json.array! data do |x|
             raise 'this should be be called' if x[:name] == 'miss'
             json.name x[:name]
           end
@@ -1143,9 +1048,10 @@ class BreezyTemplateTest < ActionView::TestCase
 
   test "filtering for a node in an array of a tree by index" do
     result = jbuild(<<-JBUILDER, breezy_filter: 'hit.hit2.0')
+      data = [{id: 1, name: 'hit' }, {id:2, name: 'miss'}]
       json.hit do
         json.hit2 do
-          json.array! [{id: 1, name: 'hit' }, {id:2, name: 'miss'}] do |x|
+          json.array! data do |x|
             raise 'this should be be called' if x[:name] == 'miss'
             json.name x[:name]
           end

data/test/template_test.rb

@@ -15,13 +15,29 @@ class NonEnumerable
   end
 
   delegate :map, :count, to: :@collection
+
+  def member_at(index)
+    @collection[index]
+  end
+
+  def member_by(attribute, value)
+    raise NotImplementedError
+  end
 end
 
-class VeryBasicWrapper < BasicObject
+class VeryBasicWrapper
   def initialize(thing)
     @thing = thing
   end
 
+  def member_at(index)
+    @thing[index]
+  end
+
+  def member_by(attribute, value)
+    raise NotImplementedError
+  end
+
   def method_missing(name, *args, &block)
     @thing.send name, *args, &block
   end
@@ -50,10 +66,6 @@ end
 
 
 class TemplateTest < ActiveSupport::TestCase
-  setup do
-    BreezyTemplate.send :class_variable_set, '@@key_formatter', nil
-  end
-
   test 'single key' do
     result = jbuild do |json|
       json.content 'hello'
@@ -260,7 +272,7 @@ class TemplateTest < ActiveSupport::TestCase
   #   assert_equal [], result['comments']
   # end
 
-  test 'nesting multiple children from a non-Enumerable that responds to #map' do
+  test 'nesting multiple children from a non-Enumerable that responds to #map, #members_at, #members_by' do
     comments = NonEnumerable.new([ Comment.new('hello', 1), Comment.new('world', 2) ])
 
     result = jbuild do |json|
@@ -292,7 +304,6 @@ class TemplateTest < ActiveSupport::TestCase
 
   test 'array! casts array-like objects to array before merging' do
     wrapped_array = VeryBasicWrapper.new(%w[foo bar])
-
     result = jbuild do |json|
       json.array! wrapped_array
     end
@@ -481,98 +492,6 @@ class TemplateTest < ActiveSupport::TestCase
   #   assert_equal 50, result['relations'][1]['age']
   # end
 
-  # reconsider
-  # test 'initialize via options hash' do
-  #   jbuilder = Jbuilder.new(key_formatter: 1, ignore_nil: 2)
-  #   assert_equal 1, jbuilder.instance_eval{ @key_formatter }
-  #   assert_equal 2, jbuilder.instance_eval{ @ignore_nil }
-  # end
-
-  test 'key_format! with parameter' do
-    result = jbuild do |json|
-      json.key_format! camelize: [:lower]
-      json.camel_style 'for JS'
-    end
-
-    assert_equal ['camelStyle'], result.keys
-  end
-
-  test 'key_format! with parameter not as an array' do
-    result = jbuild do |json|
-      json.key_format! :camelize => :lower
-      json.camel_style 'for JS'
-    end
-
-    assert_equal ['camelStyle'], result.keys
-  end
-
-  test 'key_format! propagates to child elements' do
-    result = jbuild do |json|
-      json.key_format! :upcase
-      json.level1 'one'
-      json.level2 do
-        json.value 'two'
-      end
-    end
-
-    assert_equal 'one', result['LEVEL1']
-    assert_equal 'two', result['LEVEL2']['VALUE']
-  end
-
-  test 'key_format! resets after child element' do
-    result = jbuild do |json|
-      json.level2 do
-        json.key_format! :upcase
-        json.value 'two'
-      end
-      json.level1 'one'
-    end
-
-    assert_equal 'two', result['level2']['VALUE']
-    assert_equal 'one', result['level1']
-  end
-
-  test 'key_format! with no parameter' do
-    result = jbuild do |json|
-      json.key_format! :upcase
-      json.lower 'Value'
-    end
-
-    assert_equal ['LOWER'], result.keys
-  end
-
-  test 'key_format! with multiple steps' do
-    result = jbuild do |json|
-      json.key_format! :upcase, :pluralize
-      json.pill 'foo'
-    end
-
-    assert_equal ['PILLs'], result.keys
-  end
-
-  test 'key_format! with lambda/proc' do
-    result = jbuild do |json|
-      json.key_format! ->(key){ key + ' and friends' }
-      json.oats 'foo'
-    end
-
-    assert_equal ['oats and friends'], result.keys
-  end
-
-  test 'default key_format!' do
-    BreezyTemplate.key_format camelize: :lower
-    result = jbuild{ |json| json.camel_style 'for JS' }
-    assert_equal ['camelStyle'], result.keys
-  end
-  #
-  test 'do not use default key formatter directly' do
-    BreezyTemplate.key_format
-    jbuild{ |json| json.key 'value' }
-    formatter = BreezyTemplate.send(:class_variable_get, '@@key_formatter')
-    cache = formatter.instance_variable_get('@cache')
-    assert_empty cache
-  end
-
   test 'ignore_nil! without a parameter' do
     result = jbuild do |json|
       json.ignore_nil!

data/test/test_helper.rb

@@ -11,6 +11,17 @@ ActiveSupport::TestCase.test_order = :random if ActiveSupport::TestCase.respond_
 ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 Rails.cache = ActiveSupport::Cache::MemoryStore.new
 
-load File.dirname(__FILE__) + '/support/schema.rb'
-require 'support/models'
+class ObjectCollection < SimpleDelegator
+  def member_at(index)
+    at(index)
+  end
 
+  def member_by(key, val)
+    find do |ele|
+      ele[key] == val || ele[key.to_sym] == val
+    end
+  end
+end
+
+
+require 'breezy_template/core_ext'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breezy_template
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Johny Ho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-10 00:00:00.000000000 Z
+date: 2018-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -92,12 +92,12 @@ files:
 - lib/breezy_template/breezy_template.rb
 - lib/breezy_template/cache_extension.rb
 - lib/breezy_template/configuration.rb
+- lib/breezy_template/core_ext.rb
 - lib/breezy_template/deferment_extension.rb
 - lib/breezy_template/dependency_tracker.rb
 - lib/breezy_template/digestor.rb
 - lib/breezy_template/errors.rb
 - lib/breezy_template/handler.rb
-- lib/breezy_template/key_formatter.rb
 - lib/breezy_template/partial_extension.rb
 - lib/breezy_template/search_extension.rb
 - lib/breezy_template/var.rb

data/lib/breezy_template/key_formatter.rb

@@ -1,34 +0,0 @@
-require 'breezy_template/breezy_template'
-require 'active_support/core_ext/array'
-
-class BreezyTemplate
-  class KeyFormatter
-    def initialize(*args)
-      @format = {}
-      @cache = {}
-
-      options = args.extract_options!
-      args.each do |name|
-        @format[name] = []
-      end
-      options.each do |name, parameters|
-        @format[name] = parameters
-      end
-    end
-
-    def initialize_copy(original)
-      @cache = {}
-    end
-
-    def format(key)
-      @cache[key] ||= @format.inject(key.to_s) do |result, args|
-        func, args = args
-        if ::Proc === func
-          func.call result, *args
-        else
-          result.send func, *args
-        end
-      end
-    end
-  end
-end