scrawl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44d6787a4204535288716bd360ce9a91f8ab9e8e
+  data.tar.gz: 4fe0bad5f4bd4222ee2f64b06cbaf18c088f6631
+SHA512:
+  metadata.gz: 65eac765287fe7c6aae52ce9b8e87ccb06aefa10f4b058db046c5c435ba34521d47381d1e319da747c5c2310d98194d0abdcbcd4f984af1dc7936146d5381ff4
+  data.tar.gz: 18d2f0e9e36cc7a62064a5b489e4a18f85c4941f3a45e93442826ff82bd0c76d62f3e6e8eacbe8506e94154706f8d01b2db34f11318305434b70da912d18aa8c

data/lib/scrawl.rb

@@ -0,0 +1,49 @@
+require "forwardable"
+
+# This is the main namespace for scrawl
+class Scrawl
+  extend Forwardable
+
+  KEY_VALUE_DELIMITER = "="
+  PAIR_DELIMITER = " "
+  NAMESPACE_DELIMITER = "."
+
+  attr_reader :tree
+  def_delegator :tree, :to_hash
+  def_delegator :tree, :to_h
+
+  def initialize(*trees)
+    @tree = trees.inject({}) { |global, tree| global.merge(tree) }
+  end
+
+  def merge(hash)
+    @tree.merge!(hash.to_hash)
+  end
+
+  def inspect(namespace = nil)
+    @tree.map do |key, value|
+      unless value.respond_to?(:to_hash)
+        "#{label(namespace, key)}#{KEY_VALUE_DELIMITER}#{element(value)}"
+      else
+        Scrawl.new(value).inspect(key)
+      end
+    end.join(PAIR_DELIMITER)
+  end
+
+  private
+
+  def label(namespace, key)
+    [namespace, key].compact.join(NAMESPACE_DELIMITER)
+  end
+
+  def element(value)
+    case value
+    when Proc then value.call
+    when Numeric then value
+    when Symbol then value.to_s
+    else value
+    end.inspect
+  end
+end
+
+require_relative "scrawl/version"

data/lib/scrawl/version.rb

@@ -0,0 +1,4 @@
+# This is where we define the version number for the gem
+class Scrawl
+  VERSION = "1.0.0"
+end

data/spec/lib/scraw_spec.rb

@@ -0,0 +1,172 @@
+require "spec_helper"
+
+describe Scrawl do
+  let(:input) { { a: 1 } }
+  let(:trees) { [input] }
+  let(:scrawl) { described_class.new(*trees) }
+  let(:internal_tree) { scrawl.instance_variable_get(:@tree) }
+
+  describe ".new" do
+    context "with single" do
+      shared_examples "setup single" do
+        it "sets internal tree to that hash" do
+          expect(internal_tree).to eq(input)
+        end
+      end
+
+      context "hash object" do
+        include_examples "setup single"
+      end
+
+      context "scrawl object" do
+        let(:tree) { Scrawl.new(*trees) }
+
+        include_examples "setup single"
+      end
+    end
+
+    context "with multiple" do
+      let(:merged_input) { { a: 1, b: 2 } }
+
+      shared_examples "setup all" do
+        it "merges all arguments into a single tree" do
+          expect(internal_tree).to eq(merged_input)
+        end
+      end
+
+      context "hashes objects" do
+        let(:trees) { [{ a: 1 }, { b: 2 }] }
+      end
+
+      context "scrawl objects" do
+        let(:trees) { [Scrawl.new(a: 1), Scrawl.new(b: 2)] }
+      end
+
+      context "hash and scrawl objects" do
+
+      end
+    end
+  end
+
+  describe "#merge" do
+    let(:merge) { scrawl.merge(compared) }
+
+    shared_examples "merges" do
+      it "combines with the internal tree" do
+        expect(merge).to eq(a: 1, b: 2)
+      end
+    end
+
+    context "with hash" do
+      let(:compared) { { b: 2 } }
+
+      include_examples "merges"
+    end
+
+    context "with scrawl object" do
+      let(:compared) { Scrawl.new(b: 2) }
+
+      include_examples "merges"
+    end
+  end
+
+  describe "#inspect" do
+    let(:stream) { "a=1" }
+    let(:namespace) { nil }
+    let(:inspect) { scrawl.inspect(namespace) }
+
+    context "with a single pair" do
+      it "joins the key value together with an ="  do
+        expect(inspect).to eq(stream)
+      end
+
+      context "and text value" do
+        let(:input) { { a: "example" } }
+
+        it "includes the escaped text" do
+          expect(inspect).to include("\"example\"")
+        end
+      end
+
+      context "and a proc value" do
+        let(:input) { { a: -> { "example#{rand(1..10_000)}" } } }
+
+        it "evaluate the proc" do
+          expect(inspect).to include("example")
+        end
+
+        it "never stores the value" do
+          first = scrawl.inspect
+          second = scrawl.inspect
+          expect(first).to_not eq(second)
+        end
+      end
+
+      context "and a number value" do
+        it "returns just the number" do
+          expect(inspect).to include("=1")
+        end
+      end
+
+      context "and a symbol value" do
+        let(:input) { { a: :example } }
+        it "returns the escaped string equivelent" do
+          expect(inspect).to include("\"example\"")
+        end
+      end
+    end
+
+    context "with multiple pairs" do
+      let(:input) { { a: 1, b: 2 } }
+      let(:stream) { "a=1 b=2" }
+
+      it "delimits key value pairs with space" do
+        expect(inspect).to eq(stream)
+      end
+    end
+
+    context "with a given namespace" do
+      let(:namespace) { "b" }
+      let(:stream) { "b.a=1" }
+
+      it "prefixes the namespace to the key" do
+        expect(inspect).to eq(stream)
+      end
+    end
+
+    context "with nested hash tree" do
+      let(:input) { { a: { b: 1, c: 2 } } }
+      let(:stream) { "a.b=1 a.c=2" }
+
+      it "namespaces the nested pairs" do
+        expect(inspect).to eq(stream)
+      end
+    end
+  end
+
+  describe "#tree"do
+    let(:tree) { scrawl.tree }
+
+    it "returns the internal tree" do
+      expect(tree).to eq(internal_tree)
+    end
+  end
+
+  describe "#to_h" do
+    let(:to_h) { scrawl.to_h }
+
+    it "returns the internal tree" do
+      expect(to_h).to eq(internal_tree)
+    end
+  end
+
+  describe "#to_hash"do
+    let(:to_hash) { scrawl.to_hash }
+
+    it "returns the internal tree" do
+      expect(to_hash).to eq(internal_tree)
+    end
+  end
+
+  describe "#=="
+end

data/spec/lib/scrawl/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Scrawl::VERSION do
+  it "should be a string" do
+    expect(Scrawl::VERSION).to be_kind_of(String)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "pry"
+require "rspec"
+require "scrawl"

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: scrawl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: Turn hashes into simple log-ready output
+email:
+- me@kurtisrainboltgreene.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/scrawl.rb
+- lib/scrawl/version.rb
+- spec/lib/scraw_spec.rb
+- spec/lib/scrawl/version_spec.rb
+- spec/spec_helper.rb
+homepage: http://krainboltgreene.github.io/scrawl
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Turn hashes into simple log-ready output
+test_files:
+- spec/lib/scraw_spec.rb
+- spec/lib/scrawl/version_spec.rb
+- spec/spec_helper.rb
+has_rdoc: