data_formatter 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3654332ffbe1b6c49126c5c743674b5a54a36ab0
+  data.tar.gz: 0ee60110ead328207e043649a5203bf13ca49e5e
+SHA512:
+  metadata.gz: 07999b87ff216fad567ebca2216fde67b86f4d344b904cddaf806012bc4e49b7e464364b354222bb3a4f2e47668fdff2e5264da96718bf0a800c334784816c06
+  data.tar.gz: 120b806122c993889b54386d7bf406f846e00e55a0ba7609b1c4c6af868311e8dd8a6b51f42d3ba2876edc1b21f9cfa5d0d4317017e27c9210a5b7ab63557001

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1 @@
+19 Aug 2014: Force all collection items to UTF-8 before concatinating

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Starr Horne
+
+MIT License
+
+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,29 @@
+# DataFormatter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'data_formatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install data_formatter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end

data/data_formatter.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'data_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "data_formatter"
+  spec.version       = DataFormatter::VERSION
+  spec.authors       = ["Starr Horne"]
+  spec.email         = ["snhorne@gmail.com"]
+  spec.description   = %q{Format data for display}
+  spec.summary       = %q{Format data for display}
+  spec.homepage      = ""
+  spec.license       = "All rights reserved"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency "ZenTest"
+  spec.add_development_dependency "autotest-spec"
+  spec.add_development_dependency "autotest-suffix"
+end

data/lib/data_formatter/array_collection.rb

@@ -0,0 +1,17 @@
+module DataFormatter
+  class ArrayCollection < Collection
+
+    def open
+      @open ||= Tag.new(css_class: "bracket", content: "[")
+    end
+
+    def close
+      @close ||= Tag.new(css_class: "bracket", content: "]")
+    end
+
+    def prepare(data)
+      data.map { |v| Value.new(data: v, indentation: indentation) }
+    end
+
+  end
+end

data/lib/data_formatter/collection.rb

@@ -0,0 +1,56 @@
+module DataFormatter
+  class Collection
+
+    attr_reader :items, :indentation, :separator
+
+    def initialize(args)
+      @indentation = args.fetch(:indentation)
+      @separator = args.fetch(:separator, ",")
+      @items = prepare(args.fetch(:data))
+    end
+
+    def to_s
+
+      return inline if items.length < 2 
+
+      [].tap do |output|
+        output << open
+        indentation.increase
+        items.each_with_index do |item, i| 
+          output << indent(item) + separator(i)
+        end
+        indentation.decrease
+        output << indent(close)
+      end.map do |x| 
+        x.to_s.force_encoding("UTF-8") 
+      end.join("\n")
+    end
+
+    protected
+
+      def prepare(items)
+        items
+      end
+
+      def open
+        nil
+      end
+
+      def close
+        nil
+      end
+
+      def inline
+        [open, items[0].to_s, close].compact.join
+      end
+
+      def separator(i)
+        (i < items.length-1) ? "," : ""
+      end
+
+      def indent(item)
+        indentation.indent(item)
+      end
+
+  end
+end

data/lib/data_formatter/hash_collection.rb

@@ -0,0 +1,17 @@
+module DataFormatter
+  class HashCollection < Collection
+
+    def open
+      @open ||= Tag.new(css_class: "curly-bracket", content: "{")
+    end
+
+    def close
+      @close ||= Tag.new(css_class: "curly-bracket", content: "}")
+    end
+
+    def prepare(data)
+      data.map { |k, v| ValuePair.new(key: Value.new(data: k, indentation: indentation, is_key: true), value: Value.new(data: v, indentation: indentation)) }
+    end
+
+  end
+end

data/lib/data_formatter/indentation.rb

@@ -0,0 +1,29 @@
+module DataFormatter
+  class Indentation
+
+    INDENT_CHARS = "  "
+
+    attr_accessor :indent_level
+
+    def initialize(args={})
+      @indent_level = args.fetch(:indent_level, 0)
+    end
+
+    def indent(value)
+      to_s + value.to_s
+    end
+
+    def increase
+      self.indent_level += 1
+    end
+    
+    def decrease
+      self.indent_level = [indent_level - 1, 0].max
+    end
+
+    def to_s
+      INDENT_CHARS * indent_level 
+    end
+
+  end
+end

data/lib/data_formatter/tag.rb

@@ -0,0 +1,47 @@
+require 'rack/utils'
+
+module DataFormatter
+  class Tag
+
+    attr_reader :sanitizer, :content, :css_class, :tag_name, :surround
+
+    def initialize(args)
+      @sanitizer = args.fetch(:sanitizer, Rack::Utils)
+      @tag_name = args.fetch(:tag_name, "span")
+      @content = args.fetch(:content)
+      @surround = args.fetch(:surround, nil)
+      @css_class = Array(args.fetch(:css_class, "")).compact.join(" ")
+    end
+
+    def to_s
+      [open_tag, safe_content, close_tag].join
+    end
+
+    protected
+
+      def escaped_surround 
+        "\\" + surround
+      end
+
+      def surrounded_content
+        if surround
+          [surround, content.gsub(surround, escaped_surround), surround].join
+        else
+          content
+        end
+      end
+
+      def safe_content
+        sanitizer.escape_html(surrounded_content)
+      end
+
+      def open_tag
+        %[<#{ tag_name } class="#{ css_class }">]
+      end
+
+      def close_tag
+        %[</#{ tag_name }>]
+      end
+
+  end
+end

data/lib/data_formatter/value.rb

@@ -0,0 +1,64 @@
+module DataFormatter
+  class Value
+    attr_reader :value, :is_key, :indentation
+
+    def initialize(args)
+      @value = args.fetch(:data)
+      @is_key = args.fetch(:is_key, false)
+      @indentation = args.fetch(:indentation)
+    end
+
+    def to_s
+      if is?(Numeric)
+        format_number
+      elsif is?(String)
+        format_string
+      elsif is?(TrueClass, FalseClass)
+        format_boolean
+      elsif is?(NilClass)
+        format_nil
+      elsif is?(Hash)
+        format_hash
+      elsif is?(Array)
+        format_array
+      else
+        raise "ValueFormatter value is of unsupported type: #{ value.class.name }"
+      end.to_s
+    end
+
+    protected
+
+      def is?(*klass)
+        klass.any? { |k| value.kind_of?(k) }
+      end
+
+      def format_number
+        mark_up(data: value, kind: "number" )
+      end
+
+      def format_string
+        mark_up(data: value, surround: '"', kind: "string" )
+      end
+
+      def format_boolean
+        mark_up(data: value ? "true" : "false", kind: "boolean" )
+      end
+
+      def format_nil
+        mark_up(data: "nil", kind: "nil" )
+      end
+
+      def format_hash
+        HashCollection.new(data: value, indentation: indentation)
+      end
+      
+      def format_array
+        ArrayCollection.new(data: value, indentation: indentation)
+      end
+
+      def mark_up(args)
+        Tag.new(content: args.fetch(:data), surround: args[:surround], css_class: [is_key ? "key" : nil,  args[:kind]]).to_s
+      end
+
+  end
+end

data/lib/data_formatter/value_pair.rb

@@ -0,0 +1,16 @@
+module DataFormatter
+  class ValuePair
+
+    attr_reader :key, :value
+
+    def initialize(args)
+      @key = args.fetch(:key)
+      @value = args.fetch(:value)
+    end
+
+    def to_s
+      [key.to_s, '<span class="hashrocket">&nbsp;=&gt;&nbsp;</span>', value.to_s].join
+    end
+
+  end
+end

data/lib/data_formatter/version.rb

@@ -0,0 +1,3 @@
+module DataFormatter
+  VERSION = "0.0.2"
+end

data/lib/data_formatter.rb

@@ -0,0 +1,18 @@
+require "data_formatter/version"
+require "data_formatter/indentation"
+require "data_formatter/collection"
+require "data_formatter/array_collection"
+require "data_formatter/hash_collection"
+require "data_formatter/value"
+require "data_formatter/value_pair"
+require "data_formatter/tag"
+
+module DataFormatter
+  def self.format(data) 
+    HashCollection.new(data: data, indentation: Indentation.new()).to_s
+  end
+
+  def self.format_lines(data) 
+    format(data).strip.split("\n")
+  end
+end

data/test/base_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+ 
+describe "version" do
+ 
+  it "must be defined" do
+    DataFormatter::VERSION.wont_be_nil
+  end
+
+  it "formats an empty hash" do
+    DataFormatter.format({}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "formats a string => string hash" do
+    DataFormatter.format({"a" => "b"}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"string\">&quot;b&quot;</span><span class=\"curly-bracket\">}</span>")
+  end
+  
+  it "escapes quotes in strings" do
+    DataFormatter.format({"a" => '"hi"'}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"string\">&quot;\\&quot;hi\\&quot;&quot;</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "formats a string => number hash" do
+    DataFormatter.format({"a" => 2}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"number\">2</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "formats a number => string hash" do
+    DataFormatter.format({3 => "hi"}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key number\">3</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"string\">&quot;hi&quot;</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "formats a string => nil hash" do
+    DataFormatter.format({"a" => nil}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"nil\">nil</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "formats a string => true hash" do
+    DataFormatter.format({"a" => true}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"boolean\">true</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "formats a string => false hash" do
+    DataFormatter.format({"a" => false}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"boolean\">false</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "formats a string => [] hash" do
+    DataFormatter.format({"a" => []}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"bracket\">[</span><span class=\"bracket\">]</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "formats a string => [1, 'x', nil] hash" do
+    DataFormatter.format({"a" => [1, 'x', nil]}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"bracket\">[</span>\n&nbsp;&nbsp;<span class=\"number\">1</span>,\n&nbsp;&nbsp;<span class=\"string\">&quot;x&quot;</span>,\n&nbsp;&nbsp;<span class=\"nil\">nil</span>\n<span class=\"bracket\">]</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "formats a string => {'a' => 1} hash" do
+    DataFormatter.format({"a" => {"b" => 1}}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;b&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"number\">1</span><span class=\"curly-bracket\">}</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "formats a string 'a' => 1, 'b' => 2} hash" do
+    DataFormatter.format({"a" => {"a" => 1, "b" => 2}}).must_equal("<span class=\"curly-bracket\">{</span><span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"curly-bracket\">{</span>\n&nbsp;&nbsp;<span class=\"key string\">&quot;a&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"number\">1</span>,\n&nbsp;&nbsp;<span class=\"key string\">&quot;b&quot;</span><span class=\"hashrocket\">&nbsp;=&gt;&nbsp;</span><span class=\"number\">2</span>\n<span class=\"curly-bracket\">}</span><span class=\"curly-bracket\">}</span>")
+  end
+
+  it "handles complex nested arrays" do
+    data = {"warden.user.user.key"=>["User", ["1"], "$2a$10$KA1Gt0FHACfN7i0t0A7Ly."]}
+    DataFormatter.format(data)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require "autotest/suffix"
+
+require File.expand_path('../../lib/data_formatter.rb', __FILE__)

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: data_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Starr Horne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  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'
+- !ruby/object:Gem::Dependency
+  name: autotest-spec
+  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'
+- !ruby/object:Gem::Dependency
+  name: autotest-suffix
+  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: Format data for display
+email:
+- snhorne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- data_formatter.gemspec
+- lib/data_formatter.rb
+- lib/data_formatter/array_collection.rb
+- lib/data_formatter/collection.rb
+- lib/data_formatter/hash_collection.rb
+- lib/data_formatter/indentation.rb
+- lib/data_formatter/tag.rb
+- lib/data_formatter/value.rb
+- lib/data_formatter/value_pair.rb
+- lib/data_formatter/version.rb
+- test/base_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- All rights reserved
+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.0
+signing_key: 
+specification_version: 4
+summary: Format data for display
+test_files:
+- test/base_test.rb
+- test/test_helper.rb