colonel_kurtz_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85fac15fa64598b07234a2830267c47a75246fcc
+  data.tar.gz: 5ea19fc21e7b656d5497fadc7cb11798b5333f72
+SHA512:
+  metadata.gz: 04240d2ec0e9e46c03c94c7748f2156831a97b27fe6ff14a3d661bc17700d105d63fcbd9e18f0dd0bc161bded3ac0ff15b9f30e234336b8bdcbe7a87277e53ad
+  data.tar.gz: b45a496131e8a8724293546e1b5e94793ddfc84dce412c7b0a3316d183608f2b7db38eaf315bd8251ab246e678f709d7404d8a1608afe0544069dcd1165d6081

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.1
+
+before_install: gem install bundler -v 1.10.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in colonel_kurtz_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Viget
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# ColonelKurtzRuby
+
+Ruby wrapper for Colonel Kurtz data.
+
+[![Code Climate](https://codeclimate.com/github/vigetlabs/colonel_kurtz_ruby/badges/gpa.svg)](https://codeclimate.com/github/vigetlabs/colonel_kurtz_ruby) [![Test Coverage](https://codeclimate.com/github/vigetlabs/colonel_kurtz_ruby/badges/coverage.svg)](https://codeclimate.com/github/vigetlabs/colonel_kurtz_ruby/coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'colonel_kurtz_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install colonel_kurtz_ruby
+
+## Usage
+
+Colonel Kurtz Ruby is a lightweight shim between the JSON data that Colonel Kurtz (https://github.com/vigetlabs/colonel-kurtz) creates and POROs.
+
+#### Example
+
+for Colonel Kurtz `data`:
+
+```JSON
+{
+  "type"    : "example-block",
+  "content" : { "html" : "<p>Example</p>" },
+  "blocks"  : [
+    {
+      "type"    : "example-block",
+      "content" : { "html" : "<p>Text</p>" },
+      "blocks"  : []
+    }
+  ]
+}
+```
+
+```ruby
+block = ColonelKurtz::Block.new(data)
+
+block.type
+#=> :example_block
+
+block.contents
+#=> { "html" => "<p>Example</p>" }
+
+block.children
+#=> [
+  #<ColonelKurtz::Block:0x007fb0eb7bf950....>
+]
+```
+
+#### Model
+
+Colonel Kurtz Ruby also includes a model mixin for exposing fields that contain Colonel Kurtz data.
+
+```ruby
+class BlockableExample
+  extend ColonelKurtz::Model::Blockable
+
+  has_blocks :content
+
+  attr_reader :data
+
+  def initialize(data)
+    @data = data
+  end
+
+  def content
+    JSON.generate([data])
+  end
+end
+```
+
+```ruby
+example = BlockExample.new(data)
+
+example.content_blocks
+#=> [
+  #<ColonelKurtz::Block:0x007fb0eb7bf950....
+  ...
+]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/colonel_kurtz_ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Viget (www.viget.com)

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec) 
+  task default: :spec
+rescue LoadError
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "colonel_kurtz"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/colonel_kurtz_ruby.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'colonel_kurtz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "colonel_kurtz_ruby"
+  spec.version       = ColonelKurtz::VERSION
+  spec.authors       = ["Viget"]
+  spec.email         = ["developers@viget.com"]
+
+  spec.summary       = "Ruby wrapper for Colonel Kurtz data"
+  spec.description   = "Colonel Kurtz Ruby is a lightweight shim between the JSON data that Colonel Kurtz (https://github.com/vigetlabs/colonel-kurtz) creates and POROs."
+  spec.homepage      = "https://github.com/vigetlabs/colonel_kurtz_ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler",       "~> 1.8"
+  spec.add_development_dependency "rake",          "~> 10.0"
+  spec.add_development_dependency "rspec",         "~> 3.2"
+  spec.add_development_dependency "pry",           "~> 0.10"
+  spec.add_development_dependency "activesupport", "~> 4.2"
+
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/lib/colonel_kurtz.rb

@@ -0,0 +1,10 @@
+require "colonel_kurtz/version"
+
+require "colonel_kurtz/block"
+require "colonel_kurtz/block/data"
+require "colonel_kurtz/block/type"
+
+require "colonel_kurtz/model/blockable"
+
+module ColonelKurtz
+end

data/lib/colonel_kurtz/block.rb

@@ -0,0 +1,46 @@
+# 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
+
+    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 children
+      @children ||= blocks.map{ |data| Block.new(data) }
+    end
+
+
+    private
+
+    attr_reader :data
+
+    def blocks
+      data.fetch("blocks", [])
+    end
+  end
+end

data/lib/colonel_kurtz/block/data.rb

@@ -0,0 +1,27 @@
+module ColonelKurtz
+  class Block
+
+
+    private
+
+    class Data
+
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+      def to_hash
+        defined?(HashWithIndifferentAccess) ? with_indifferent_access(data) : data
+      end
+
+
+      private
+
+      def with_indifferent_access(hash)
+        HashWithIndifferentAccess.new(hash)
+      end
+    end
+  end
+end

data/lib/colonel_kurtz/block/type.rb

@@ -0,0 +1,24 @@
+module ColonelKurtz
+  class Block
+
+
+    private
+
+    class Type
+
+      attr_reader :type
+
+      def initialize(type)
+        @type = type
+      end
+
+      def formatted_type
+        type.gsub("-", "_").downcase
+      end
+
+      def to_sym
+        formatted_type.to_sym
+      end
+    end
+  end
+end

data/lib/colonel_kurtz/model/blockable.rb

@@ -0,0 +1,21 @@
+require "json"
+
+module ColonelKurtz
+  module Model
+    module Blockable
+
+      def has_blocks(*fields)
+        fields.each do |field|
+
+          define_method "#{field}_blocks" do
+            begin
+              JSON.parse(send(field)).map{ |data| ColonelKurtz::Block.new(data) }
+            rescue
+              [] # TODO error handling
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/colonel_kurtz/version.rb

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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: colonel_kurtz_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Viget
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Colonel Kurtz Ruby is a lightweight shim between the JSON data that Colonel
+  Kurtz (https://github.com/vigetlabs/colonel-kurtz) creates and POROs.
+email:
+- developers@viget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- colonel_kurtz_ruby.gemspec
+- lib/colonel_kurtz.rb
+- lib/colonel_kurtz/block.rb
+- lib/colonel_kurtz/block/data.rb
+- lib/colonel_kurtz/block/type.rb
+- lib/colonel_kurtz/model/blockable.rb
+- lib/colonel_kurtz/version.rb
+homepage: https://github.com/vigetlabs/colonel_kurtz_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Colonel Kurtz data
+test_files: []