json2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51f0cb006cd0e9d7641a2beb85a77ff46258f693
+  data.tar.gz: 84d96f803db004b7b12b2eb313bd4fca9de1fb9f
+SHA512:
+  metadata.gz: 7317aa9c145dd7fcc928e5223cc26bcdf3b9f66ed7d3d2076f44336a54806b437c38a3fa2360185132c01b2cff11ce06b46a76ce482bc8e768e8d0be3426cda1
+  data.tar.gz: 0f5918f0343a5b281ea5bac2240a6194a201ee725162040f86fa42e7a02555f05303fc7033d12c81e765a8af20e49ec1ae48ef5debd041c68dd32b8a79999571

data/.coco.yml

@@ -0,0 +1,3 @@
+:excludes:
+- spec
+- lib/json2/version.rb

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+TODO

data/.reek

@@ -0,0 +1,7 @@
+UncommunicativeModuleName:
+  enabled: false
+
+TooManyStatements:
+  exclude:
+  - "Json2::Option#parse" # OptionParser is not «short method friendly».
+  - initialize

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order=random

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased] - unreleased
+
+## [0.1.0] - 2015-07-10
+### Added
+- Basic Json to Csv behavior, based on several Json examples.
+- Works well with other command line tools by using a file as input or by
+  listening to STDIN.
+- Option `--without-header` to parse the Json when it doesn't seems to have
+  *heading information* inside itself.
+- Option `--path` to extract a selection of the Json file.
+- Common switches `--version` and `--help`.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 lkdjiin
+
+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,154 @@
+# Json2
+
+Json2 transforms a Json file into a Csv one.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json2
+
+## Usage
+
+### Example 1
+
+Given the following Json file:
+
+```json
+[
+	{
+		"color": "red",
+		"value": "#f00"
+	},
+	{
+		"color": "green",
+		"value": "#0f0"
+	},
+	{
+		"color": "blue",
+		"value": "#00f"
+	}
+]
+```
+
+You could obtain a Csv with a header like that:
+
+    $ json2 colors-array.json 
+    color,value
+    red,#f00
+    green,#0f0
+    blue,#00f
+
+### Example 2
+
+With this simpler kind of Json:
+
+```json
+{
+    "red":"#f00",
+    "green":"#0f0",
+    "blue":"#00f"
+}
+```
+
+Here is the resulting Csv:
+
+
+    $ json2 colors3.json 
+    red,green,blue
+    #f00,#0f0,#00f
+
+### Example 3
+
+Take a slightly more complicated Json file:
+
+```json
+{
+	"id": "0001",
+	"type": "donut",
+	"batters":
+		{
+			"batter":
+				[
+					{ "id": "1001", "type": "Regular" },
+					{ "id": "1002", "type": "Chocolate" },
+					{ "id": "1003", "type": "Blueberry" },
+					{ "id": "1004", "type": "Devil's Food" }
+				]
+		},
+	"topping":
+		[
+			{ "id": "5001", "type": "None" },
+			{ "id": "5002", "type": "Glazed" },
+			{ "id": "5005", "type": "Sugar" }
+		]
+}
+```
+
+Say you want to extract the *batter* stuff. Use the `--path` switch:
+
+    $ json2 --path='batters.batter' products.json 
+    id,type
+    1001,Regular
+    1002,Chocolate
+    1003,Blueberry
+    1004,Devil's Food
+
+### Example 4
+
+Json don't always map very well with Csv.
+Sometimes there is simply no header information inside the Json:
+
+```json
+{
+    "Nom du parti": {
+        "Abstention": [
+            "Jean"
+        ],
+        "Non-votant": [],
+        "Contre": [
+            "Alice",
+            "Georges"
+        ],
+        "Pour": [
+            "Julie"
+        ]
+    }
+}
+```
+
+In this case, you can use the `--without-header` switch:
+
+    $ json2 --without-header votes.json 
+    Nom du parti,Abstention,Jean
+    Nom du parti,Non-votant,
+    Nom du parti,Contre,Alice
+    Nom du parti,Contre,Georges
+    Nom du parti,Pour,Julie
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/json2/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
+
+## License
+
+MIT
+
+## Questions and/or Comments
+
+Feel free to email [Xavier Nayrac](mailto:xavier.nayrac@gmail.com)
+with any questions, or contact me on [twitter](https://twitter.com/lkdjiin).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/json2

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'json2'
+
+opt = Json2::Option.new
+
+input = JSON.parse((ARGV[0] ? File.open(ARGV[0]) : $stdin).read)
+
+json = if opt[:without_header]
+         Json2::CsvWithoutHeader.new(input)
+       else
+         Json2::CsvWithHeader.new(input, opt)
+       end
+
+print json.output

data/json2.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json2"
+  spec.version       = Json2::VERSION
+  spec.authors       = ["lkdjiin"]
+  spec.email         = ["xavier.nayrac@gmail.com"]
+  spec.summary       = %q{Transform json to csv.}
+  spec.description   = %q{json2 takes a json file as input and outputs a clean
+                          csv.}
+  spec.homepage      = "https://github.com/lkdjiin/json2"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "reek", "~> 3.0"
+  spec.add_development_dependency "coco", "~> 0.13.0"
+  spec.add_development_dependency "flay"
+end

data/lib/json2.rb

@@ -0,0 +1,14 @@
+require 'json'
+require 'optparse'
+
+require "json2/symbol_respond_to"
+require "json2/version"
+require "json2/csv_with_header"
+require "json2/csv_without_header"
+require "json2/header"
+require "json2/body"
+require "json2/option"
+
+# Transform a Json file into Csv.
+module Json2
+end

data/lib/json2/body.rb

@@ -0,0 +1,53 @@
+module Json2
+
+  # Build a csv body.
+  class Body
+
+    # Get the body of a Csv file.
+    #
+    # For a description of the parameters see Body#initialize.
+    #
+    # Returns the String body, that is several lines in a single string,
+    # each lines with comma separated values.
+    def self.get(nodes, keys, column_size)
+      new(nodes, keys, column_size).get
+    end
+
+    # Creates a new Body instance.
+    #
+    # nodes       - A Hash representing all columns. The key is the
+    #               Symbol column's header and the value is an Array
+    #               full of column's values.
+    # keys        - An Array of Symbol header's column. Why passing the
+    #               column's names while they are contained in `nodes`?
+    #               This is because we want the header's names in that
+    #               particular order given by `keys`, we can't rely on
+    #               the order of the *Hash* `nodes`.
+    # column_size - The Fixnum size of a column. TODO I think this
+    #               parameter isn't needed.
+    def initialize(nodes, keys, column_size)
+      @nodes = nodes
+      @column_size = column_size
+      @keys = keys
+      @body = ''
+    end
+
+    # Get the body of a Csv file. See also Body.get.
+    #
+    # Returns the String body.
+    def get
+      (0...@column_size).each {|observation| process_line(observation) }
+      @body
+    end
+
+    private
+
+    def process_line(observation)
+      line = []
+      @keys.each {|key| line << @nodes[key][observation] }
+      @body += line.join(',') + "\n"
+    end
+
+  end
+
+end

data/lib/json2/csv_with_header.rb

@@ -0,0 +1,86 @@
+module Json2
+
+  # Turn a Json input into a Csv output with a header.
+  class CsvWithHeader
+
+    # Creates a new CsvWithHeader instance.
+    #
+    # input   - A Hash representing a Json file. This is typically
+    #           obtained with JSON.parse.
+    # options - Optional. A Hash of options, see Option to get the list.
+    def initialize(input, options = {})
+      @options = options
+      @input = input
+      @names_stack = []
+      @nodes = Hash.new {|hash, key| hash[key] = [] }
+      process_input
+      @column_size = @nodes.values.map {|node| node.size }.max
+      @keys = @nodes.keys.select {|key| @nodes[key].size == @column_size }
+    end
+
+    # Get the Csv.
+    #
+    # Returns the whole document as a single String.
+    def output
+      Header.get(@keys) + Body.get(@nodes, @keys, @column_size)
+    end
+
+    private
+
+    def process_input
+      if @input.respond_to?(:each_key)
+        process_keys(@input)
+      else
+        process_array(@input)
+      end
+    end
+
+    def process_keys(object)
+      if object.respond_to?(:each_key)
+        object.each_key do |key|
+          @names_stack.push(key)
+          process_key(object[key])
+          @names_stack.pop
+        end
+      else
+        error(98, 'Error, try with json2 --without-header')
+      end
+    end
+
+    def process_key(object)
+      case object
+      when ~:each_key then process_keys(object)
+      when ~:at then process_array(object)
+      else
+        @nodes[current_line] <<= object if line_eligible?
+      end
+    end
+
+    def process_array(object)
+      object.each {|element| process_keys(element) }
+    end
+
+    def current_line
+      @names_stack.join('.')
+    end
+
+    def line_eligible?
+      with_a_good_path? || without_path?
+    end
+
+    def with_a_good_path?
+      @options[:with_path] && current_line.start_with?(@options[:path])
+    end
+
+    def without_path?
+      !@options[:with_path]
+    end
+
+    def error(code, message)
+      warn(message)
+      exit(code)
+    end
+
+  end
+
+end