ss2json 0.0.1 → 0.0.2

data/Changelog

@@ -0,0 +1,10 @@
+2012-05-23  Guillermo Alvarez <guillermo@cientifico.net>
+
+	* row_converter.rb (sanitize_key) : Added the option to downcase the first
+	letter
+
+
+
+2012-05-16 Guillermo Alvarez Fernandez <guillermo@cientifico.net>
+
+	* all : Initial import

data/README.md

@@ -1,11 +1,16 @@
 
 # ss2json
 
+
 **ss2json** is a SpreadSheet To Json converter. It follow a few rules for generating nested hash.
 
+## Tutorial
+
+### Step 1
+
 For example, this document:
 
-![Excel](https://github.com/guillermo/ss2json/raw/master/doc/ss2json-2.png "Title is optional")
+![Excel](https://github.com/wooga/ss2json/raw/master/doc/ss2json-2.png "Title is optional")
 
 We download as an OpenOffice document (ods), and run:
 
@@ -13,45 +18,92 @@ We download as an OpenOffice document (ods), and run:
 
 Will converted in this:
 
-```javscript
+```javascript
+[
+  {
+    "id": 1,
+    "name": { "first": "Guillermo", "last": "Alvarez" },
+    "child": [ { "name": "pepe", "age": 2 }, { "name": "Juanjo" } ]
+  },
+  {
+    "id": 2,
+    "name": { "first": "Martin", "last": "Luther" },
+    "child": [ { "name": "Jr" } ]
+  },
+  {
+    "id": 3,
+    "name": { "first": "Jesper" }
+  },
+  { "id": 4 },
+  { "id": 5 },
+  { "id": 6 }
+]
+```
+
+### Step 2
+
+We want to remove the last columns, so we need to tell **ss2json** to check for the name. We do that with the __-c__ parameter.
+
+```
+ss2json -f documents.ods -c name
+```
+
+```javascript
 [
   {
     "id": 1,
-    "name": {
-      "first": "Guillermo",
-      "last": "Alvarez"
-    },
-    "child": [
-      {
-        "name": "pepe",
-        "age": 2
-      },
-      {
-        "name": "Juanjo"
-      }
-    ]
+    "name": { "first": "Guillermo", "last": "Alvarez" },
+    "child": [ { "name": "pepe", "age": 2 }, { "name": "Juanjo" } ]
   },
   {
     "id": 2,
-    "name": {
-      "first": "Martin",
-      "last": "Luther"
-    },
-    "child": [
-      {
-        "name": "Jr"
-      }
-    ]
+    "name": { "first": "Martin","last": "Luther"},
+    "child": [{"name": "Jr"}]
   },
   {
     "id": 3,
-    "name": {
-      "first": "Jesper"
-    }
+    "name": {"first": "Jesper"}
   }
 ]
 ```
 
+### Step 3
+
+We have a crappy parser, and need to include blank_fieds, so we say that to ss2json.
+
+```
+ss2json -f documents.ods -c name -b
+```
+
+
+### Step 4
+
+We have the rows with the title in colum 3, as in:
+
+![Excel](https://github.com/wooga/ss2json/raw/master/doc/ss2json-1.png "Title is optional")
+
+So we say to **ss2json** to start parsing in the row tree:
+
+```
+ss2json -f documents.ods -c name -r 3
+```
+
+### Step 5
+
+We don't want to open the file to have a list of the sheets:
+
+```
+ss2json -f documents.ods -l
+```
+
+
+
+## Support
+
+Right now ss2json supports ods and xlsx files.
+
+
+
 ## Install
 
     gem install ss2json
@@ -78,6 +130,11 @@ Usage: ss2json -f FILENAME [options]
     -h, --help                       Show this help
 ```
 
+## TODO
+
+  * Support all the document formats from **roo** librarly.
+  * -c options should be able to check inside the hash, for example name.first should check {"name":{"first": null}}
+
 ## License
 
 BSD

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+
+
+
+desc "test"
+task :test do
+  sh "ruby -I lib -rubygems test/*_test.rb"
+end

data/lib/ss2json/cli.rb

@@ -6,16 +6,28 @@ class Ss2Json
   class Cli
     attr_reader :content, :doc
 
+    # Parse the options from ARGV, initialize the conversion, and return the string with the output
     def self.start
       options = Ss2Json::Options.parse!
       converter =  new(options)
-      if options[:action] == :list
+      case options[:action]
+      when :list
         converter.doc.sheets.join("\n")
       else
         JSON.pretty_generate(converter.content)
       end
     end
 
+    # Create a new converter the options are:
+    #
+    #   * **:file** Input file.
+    #   * **:sheet** Name of the sheet to use.
+    #   * **:first_row** Where the title of the columns is.
+    #   * **:check_column** Output only the results with a value present on the specific field.
+    #   * **:action** Could
+    #     * *:convert* Do the normal conversion.
+    #     * *:list* Will list the sheets.
+    #   * **:converter**: Options passed to the converter: Ss2Json::RowConverter
     def initialize(options)
       @options = options
       init_document

data/lib/ss2json/options.rb

@@ -9,10 +9,12 @@ class Ss2Json
       :sheet => nil,
       :file => nil,
       :check_column => nil,
+      :action => :convert,
       :converter => {
         :show_null => false,
         :dont_convert => false,
-        :ignored_values => []
+        :ignored_values => [],
+        :downcase_first_letter => true
       }
 
     }
@@ -59,6 +61,10 @@ class Ss2Json
           @options[:converter][:dont_convert] = true
         end
 
+        opts.on("-l", "--disable-first-letter", "Will disable the downcase of the first letter of the key") do
+          @options[:converter][:downcase_first_letter] = false
+        end
+
         opts.separator ""
 
         opts.on("-l", "--list-sheets", "Return the list of sheets") do |file|

data/lib/ss2json/row_converter.rb

@@ -3,6 +3,14 @@ require 'nested_hash'
 class Ss2Json
   class RowConverter < NestedHash
 
+    # Create a nested_hash from a hash with just one level (key,value).
+    #
+    # The options are:
+    #
+    #   * **:ignored_values** Array of ignored values.
+    #   * **:show_null** Export the keys with empty values.
+    #   * **:dont_convert** Convert 10.0 float values to integers.
+    #   * **:downcase_first_letter** Convert to downcase the first letter of each key.
     def initialize(hash, options={})
       @options = options
       super(hash)
@@ -18,24 +26,30 @@ class Ss2Json
       false
     end
 
-    def sanitize_value(v)
-      return v if @options[:dont_convert]
-    end
-
     def process(key,value)
       super if valid_value?(value)
     end
 
     def valid_value?(value)
-      !@options[:ignored_values].include?(value) &&
-        (@options[:show_null] || value )
+      @options[:show_null] || !ignored_values.include?(value)
     end
 
+    def ignored_values
+      (@options[:ignored_values] || []) << nil
+    end
+
+
     def sanitize_value(v)
       return v if @options[:dont_convert]
       return v.to_i if v.is_a?(Float) && v % 1 == 0
       v
     end
 
+    def sanitize_key(key)
+      return key unless is_valid_key?(key)
+      key = key[0..1].downcase + key[2..-1] if @options[:downcase_first_letter]
+      key
+    end
+
   end
 end

data/lib/ss2json/version.rb

@@ -1,3 +1,3 @@
 class Ss2json
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/row_converter_test.rb

@@ -0,0 +1,60 @@
+
+require 'ss2json'
+require 'test/unit'
+
+class Ss2Json::RowConverterTest < Test::Unit::TestCase
+
+  def test_class
+    nested_hash = Ss2Json::RowConverter.new({})
+    nested_hash.is_a?(Hash)
+  end
+
+  def test_ignored_values_option
+    options = {:ignored_values => ["???"]}
+    new_hash = Ss2Json::RowConverter.new({"adsf" => '???'},options)
+    assert_equal({}, new_hash)
+    new_hash = Ss2Json::RowConverter.new({"asdf" => 'asdf'}, options)
+    assert_equal({"asdf" => 'asdf' }, new_hash)
+  end
+
+  def test_show_null_option
+    initial_hash = {"asdf" => nil}
+    new_hash = Ss2Json::RowConverter.new(initial_hash,{:show_null => false})
+    assert_equal({}, new_hash)
+
+    new_hash = Ss2Json::RowConverter.new(initial_hash,{:show_null => true})
+    assert_equal({"asdf" => nil}, new_hash)
+  end
+
+  def test_dont_convert_option
+    initial_hash = { "asdf" => 3.0 }
+
+    new_hash = Ss2Json::RowConverter.new(initial_hash, {:dont_convert => true})
+    assert_equal(initial_hash, new_hash)
+
+    new_hash = Ss2Json::RowConverter.new(initial_hash, {:dont_convert => false})
+    assert_equal(initial_hash, { "asdf" => 3 })
+  end
+
+  def test_downcase_first_letter
+    initial_hash = { "Asdf.pepe" => 3, "asdf.Jose" => 5 }
+
+    new_hash = Ss2Json::RowConverter.new(initial_hash, {:downcase_first_letter => false})
+    assert_equal({"Asdf"=>{"pepe"=>3}, "asdf"=>{"Jose"=>5}}, new_hash)
+
+    new_hash = Ss2Json::RowConverter.new(initial_hash, {:downcase_first_letter => true})
+    assert_equal({"asdf" => {"pepe" => 3, "jose" => 5}}, new_hash)
+  end
+
+  def test_it_ignore_ignored_fields
+    initial_hash = { "i.asdf" => 5}
+
+    new_hash = Ss2Json::RowConverter.new(initial_hash)
+    assert_equal({}, new_hash)
+
+    initial_hash = { "name.i" => 5}
+
+    new_hash = Ss2Json::RowConverter.new(initial_hash)
+    assert_equal({"name" => {"i" => 5}}, new_hash)
+  end
+end

metadata

@@ -1,48 +1,63 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: ss2json
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
-authors:
-- Guillermo Álvarez
+authors: 
+- "Guillermo A\xCC\x81lvarez"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-16 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-05-23 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: nested_hash
-  requirement: &70291603211580 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70291603211580
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: roo
-  requirement: &70291603210920 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70291603210920
+  version_requirements: *id002
 description: Convert SpreadSheet documents to json following some conventions.
-email:
+email: 
 - guillermo@cientifico.net
-executables:
+executables: 
 - ss2json
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
-- CHANGELOG
+- Changelog
 - Gemfile
 - README.md
 - Rakefile
@@ -55,34 +70,43 @@ files:
 - lib/ss2json/row_converter.rb
 - lib/ss2json/version.rb
 - ss2json.gemspec
+- test/row_converter_test.rb
 - test/ss2json (1).ods
 - test/ss2json.ods
 - test/ss2json.xls
-homepage: ''
+has_rdoc: true
+homepage: ""
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: ss2json
-rubygems_version: 1.8.16
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: SpreadSheet to Json convert
-test_files:
-- test/ss2json (1).ods
-- test/ss2json.ods
-- test/ss2json.xls
+test_files: []
+

data/CHANGELOG

@@ -1,5 +0,0 @@
-
-
-2012-05-16 Guillermo Alvarez Fernandez <guillermo@cientifico.net>
-
-    * all : Initial import