beret 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 080b4b65d075cdafbd2c3b47ca269e0ffb96f667
-  data.tar.gz: 79c7eaf729ffe3f9605080eb117743db5fd700be
+  metadata.gz: 3a817f9ff6f03c7ae6d433570a362cfb69aa8f77
+  data.tar.gz: 8f13e43d494aa258a1fc6ecdf8f52ae54ff66ce9
 SHA512:
-  metadata.gz: 80e88484b46722c3d144acc41f9659d32a818aa42332cf58c627d581f0a96ccc3e63390b8c12b6e715ebbd0f9138ffef96417dce260583f8fd7f93c303c259c7
-  data.tar.gz: a2279ac02496949c267b43315ae24637100a982c8f4fd0877bec82f4e3dc54162fee79523db15a1623d70479be1fb320d9dda79551ab646de3496afa322163da
+  metadata.gz: ec88df2a4876be85eb9f3797e23e197130cc54d1bae0f7d1580aa9c0ab4f800e960e1458046847f37affee04a7d08b038f82c5ecbf09d4a9732630dd902dc0ab
+  data.tar.gz: 18756d96c65e26303c8d3c79b212dea5ae6dda16de0ca70056d7da78f15e803c3975c5f117faf6a50d3b815810d7642854435a4c65b22c140b4d119666dcaf2f

data/README.md

@@ -21,3 +21,25 @@ Or install it yourself as:
 ## Usage
 
 Beret lets you easily work with [Colonel Kurtz](https://github.com/vigetlabs/colonel-kurtz)-generated JSON data in your Ruby application.
+
+### Examples
+```ruby
+# Grab your CK JSON from wherever it lives.
+ck_json = "[{\"content\":{\"text\":\"This is some text.\"},\"type\":\"redactor\",\"blocks\":[{\"type\":\"image\", \"content\":{\"photo_id\":\"42\"}},{\"type\":\"avatar\", \"content\":{\"photo_id\":\"144\"}}]}]"
+
+# Initialization
+beret = Beret.new(ck_json)
+
+# Finding values
+beret.find(field: :photo_id) # => [<Beret::Result value="42">, <Beret::Result value="144">]
+beret.find(field: :photo_id, in: [:image]) # => [<Beret::Result value="42">]
+beret.find(field: :photo_id, in: [:avatar]) # => [<Beret::Result value="144">]
+beret.find(field: :photo_id, in: [:some_other_block_type]) # => []
+
+# In-place updating
+beret.update(:count, in: [:kitten_count]) do |value|
+  value + " kittens"
+end
+
+# Retrieving JSON
+beret.to_json

data/lib/beret/block.rb

@@ -0,0 +1,62 @@
+require "securerandom"
+
+module Beret
+  class Block
+
+    attr_reader :id, :parent
+
+    def initialize(block_json, options={})
+      @id = SecureRandom.uuid
+      @block_json = block_json
+      @parent = options[:parent]
+    end
+
+    def attributes
+      @attributes ||= block_json[content_key]
+    end
+
+    def update_attribute(field_name, value)
+      @attributes[field_name.to_s] = value
+    end
+
+    def type
+      block_json[type_key]
+    end
+
+    def children
+      @children ||= begin
+        block_json[children_key] && block_json[children_key].map do |block|
+          Block.new(block, parent: self)
+        end
+      end
+    end
+
+    def to_json
+      {}.tap do |json|
+        json[type_key] = block_json[type_key]
+        json[content_key] = attributes
+
+        if children
+          json[children_key] = children.map(&:to_json)
+        end
+      end
+    end
+
+    private
+
+    attr_reader :block_json
+
+    def children_key
+      "blocks"
+    end
+
+    def content_key
+      "content"
+    end
+
+    def type_key
+      "type"
+    end
+
+  end
+end

data/lib/beret/block_set.rb

@@ -0,0 +1,36 @@
+module Beret
+  class BlockSet
+
+    def initialize(block_json)
+      @block_json = block_json
+    end
+
+    def find(field_name, options)
+      Search.new(blocks, field_name, options).results
+    end
+
+    def update(field_name, options)
+      results = find(field_name, options)
+
+      results.each do |result|
+        new_value = yield result.value
+        result.block.update_attribute(field_name, new_value)
+      end
+    end
+
+    def blocks
+      @blocks ||= block_json.map do |block|
+        Block.new(block)
+      end
+    end
+
+    def to_json
+      blocks.map(&:to_json)
+    end
+
+    private
+
+    attr_reader :block_json
+
+  end
+end

data/lib/beret/search.rb

@@ -0,0 +1,34 @@
+module Beret
+  class Search
+
+    def initialize(block_set, field_name, options={})
+      @block_set = block_set
+      @field_name = field_name.to_s
+      @applicable_block_types = Array(options.fetch(:in, [])).map(&:to_s)
+    end
+
+    def results
+      block_list = flatten_block_set(block_set)
+      block_list.map do |block|
+        if (applicable_block_types.empty? || applicable_block_types.include?(block.type)) && block.attributes.has_key?(field_name)
+          SearchResult.new(block, field_name)
+        end
+      end.compact
+    end
+
+    private
+
+    attr_reader :applicable_block_types, :block_set, :field_name
+
+    def flatten_block_set(block_set)
+      block_set.each do |entry|
+        if entry.children
+          block_set = [block_set, flatten_block_set(entry.children)].compact.flatten
+        end
+      end
+
+      block_set
+    end
+
+  end
+end

data/lib/beret/search_result.rb

@@ -0,0 +1,16 @@
+module Beret
+  class SearchResult
+
+    attr_reader :block, :field_name
+
+    def initialize(block, field_name)
+      @block = block
+      @field_name = field_name
+    end
+
+    def value
+      block.attributes.fetch(field_name)
+    end
+
+  end
+end

data/lib/beret/version.rb

@@ -2,8 +2,8 @@ module Beret
 
   VERSION = [
     0,    # major
-    1,    # minor
+    2,    # minor
     0     # patch
   ].join('.')
-  
+
 end

data/lib/beret.rb

@@ -1,11 +1,16 @@
-require "beret/version"
-
-# require "colonel_kurtz/block"
-# require "colonel_kurtz/block/data"
-# require "colonel_kurtz/block/type"
-# require "colonel_kurtz/model/blockable"
+require "json"
 
-require "beret/hash"
+require "beret/version"
+require "beret/block"
+require "beret/search"
+require "beret/search_result"
+require "beret/block_set"
 
 module Beret
+  def self.new(json)
+    array = JSON.parse(json)
+    Beret::BlockSet.new(array)
+  rescue JSON::ParserError
+    raise "String provided to Beret.new() was not valid JSON."
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beret
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lawson Kurtz (Viget)
@@ -23,7 +23,10 @@ files:
 - README.md
 - beret.gemspec
 - lib/beret.rb
-- lib/beret/hash.rb
+- lib/beret/block.rb
+- lib/beret/block_set.rb
+- lib/beret/search.rb
+- lib/beret/search_result.rb
 - lib/beret/version.rb
 homepage: https://github.com/vigetlabs/beret
 licenses:

data/lib/beret/hash.rb

@@ -1,52 +0,0 @@
-# Ruby wrapper for Colonel Kurtz data
-#
-# Contents of `data` hash
-#
-#   type:
-#     block type
-#     string, lower-cased and dashed, e.g. "hero-photo"
-#
-#   content:
-#     block content
-#     hash
-#
-#   blocks:
-#     block children
-#     array of `data` hashes
-#
-
-module ColonelKurtz
-  class Block
-
-    attr_reader :parent
-
-    def initialize(data)
-      @data = Data.new(data).to_hash
-    end
-
-    def type
-      @type ||= Type.new(data.fetch("type")).to_sym
-    end
-
-    def content
-      @content ||= data.fetch("content", {})
-    end
-
-    def parent
-      @parent ||= data.fetch("parent", nil)
-    end
-
-    def children
-      @children ||= blocks.map{ |data| Block.new(data.merge("parent" => self)) }
-    end
-
-
-    private
-
-    attr_reader :data
-
-    def blocks
-      data.fetch("blocks", [])
-    end
-  end
-end