ss2json 0.3.2 → 1.0.0.pre

data/README.md

@@ -1,8 +1,35 @@
-
 # ss2json
 
+**ss2json** is a collection of tools to help in the conversion of spreadsheet to json.
+
+* [ss2json-vertical](#ss2json-vertical) Generate an array of rows. Each row is going to be a hash.
+* [ss2json-vertical-hash](#ss2json-vertical-hash) Generate a hash of elements. Each element is a hash that represents a column. The key of that hash is a column.
+* [ss2json-horizontal](#ss2json-horizontal) Generate a hash from a key value pairs. The keys are in one column and the values in other.
+* [merge-jsons](#merge-jsons) Generate a hash that have the filename as a key, and the content as a value.
+* [order-json](#order-jsons) Order the keys of the hashes of a json file.
+* [compress-json](#compress-json) Compress the given json. The lasts commands output in pretty format (human readable). You can pipe through this command to compress.
+* [catss](#catss) Shows on the terminal the content of the sheet
+
+## Tools
+
+### ss2json-vertical
+
+Lets start with this command to show the basic feature of ss2json.
+Suppose we have this sheet:
+
+      | A  | B         | C             | D            | E             | F            | G               | H                 | I         |
+    1 | id | name      | childs.1.name | childs.1.age | childs.2.name | Childs.2.age | address.street  | address.post_code | i.notes   |
+    2 | 1  | Guillermo |               |              |               |              | Calle de Eros 7 | 28018             | nice guy  |
+    3 | 2  | Epi       | Carlos        |              |               |              | Castellana      | 28020             |           |
+    4 | 3  | Esther    | Roberto       | 3            | Carlos        | 4            |                 |                   |           |
+    5 | 4  |           |               |              |               |              |                 |                   | left note |
+
+What we see here is that the column names (row 1) have a special encoding.
+
+### ss2json-hash
+
+### ss2json-horizontal
 
-**ss2json** is a SpreadSheet To Json converter. It follow a few rules for generating nested hash.
 
 ## Tutorial
 

data/Rakefile

@@ -1,8 +1,16 @@
 require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler/setup'
 
 
 
-desc "test"
-task :test do
-  sh "ruby -I lib -rubygems test/*_test.rb"
-end
+# desc "test"
+# task :test do
+#   sh "ruby -I lib -rubygems test/**/*_test.rb"
+# end
+
+# require 'rake/testtask'
+#
+# Rake::TestTask.new do |t|
+#   t.pattern = "test/**/*_test.rb"
+# end

data/bin/ss2json

@@ -1,7 +1,42 @@
 #!/usr/bin/env ruby
 
-require 'roo'
-require 'ss2json'
+if ARGV[0] && !(ARGV[0] =~ /^-/)
+  begin
+    require "ss2json-commands/#{ARGV[0]}"
+    kommand = SS2JSON::Command.const_get(ARGV[0].gsub(/^.|_./){|a| a[-1].chr.upcase})
+    $0="#{$0} #{ARGV[0]}"
+    $stderr.puts "ss2json: '#{ARGV[0]}' is not a ss2json command. See 'ss2json --help'. (#{e.message})"
+    exit -1
+  end
+else
 
+  require 'ss2json/command'
+  require 'optparse'
 
-puts Ss2Json::Cli.start
+  available_commands = []
+  SS2JSON::Command.load_all
+  SS2JSON::Command.commands.each do |command|
+    available_commands << [command.name, command.description]
+  end
+
+  opts = OptionParser.new do |opts|
+    opts.banner = "Usage: #{$0} ACTION [options]"
+
+    opts.separator ""
+    opts.separator "Where ACTION could be:"
+    available_commands.each do |cmd|
+      opts.separator "\t%-10s%s" % cmd
+    end
+    opts.separator ""
+
+    opts.on("-h", "--help", "Show this help") do
+      puts opts
+    end
+  end
+
+  ARGV[0] = "--help" if ARGV.size == 0
+  opts.parse!(ARGV)
+
+
+
+end

data/lib/ss2json-commands/cat.rb

@@ -0,0 +1,71 @@
+
+
+
+
+require 'ss2json/command'
+require 'ss2json/converter'
+require 'optparse'
+require 'terminal-table'
+require 'json'
+
+class Cat < SS2JSON::Command
+
+  def self.name
+    "cat"
+  end
+
+  def self.description
+    "Shows a nice console friendly table of the sheet"
+  end
+
+  def initialize(options)
+    options = Options.new(options).options
+    converter = SS2JSON::Converter.new(options)
+    puts ::Terminal::Table.new :rows => converter.to_a
+  end
+
+  class Options < ::OptionParser
+    attr_reader :options
+    DEFAULT_OPTIONS = {
+      :sheet => nil,
+      :file => nil,
+    }
+
+    def initialize(args)
+      @options = DEFAULT_OPTIONS
+      @help = nil
+      super() do |opts|
+        @help = opts
+
+        opts.banner =  "Usage: #{$0} FILENAME [sheet]"
+
+        opts.separator "\n"
+
+        opts.on_tail("-h","--help", "Show this help") do
+          puts opts
+          exit 0
+        end
+
+        opts.on_tail("--version", "Show the version") do
+          require 'ss2json/version'
+          puts "#{$0} Version: #{SS2JSON::VERSION}"
+          exit 0
+        end
+      end.parse!(args)
+
+      if file = args.shift
+        @options[:file] = file
+        @options[:sheet] = args.shift
+      else
+        die("Incorrect number of parameters")
+      end
+    end
+
+    def die(msg)
+      $stderr.puts msg
+      $stderr.puts @help
+      exit -1
+    end
+  end
+
+end

data/lib/ss2json-commands/compress.rb

@@ -0,0 +1,67 @@
+require 'ss2json/command'
+require 'optparse'
+
+class Compress < SS2JSON::Command
+
+  def self.name
+    "compress"
+  end
+
+  def self.description
+    "Uglify a json file (DO NOT RESPECT ORDER)"
+  end
+
+  def initialize(options)
+    options = Options.new(options).options
+    puts JSON.parse(options[:file].read).to_json
+  ensure
+    options[:file].close if options[:file]
+  end
+
+  class Options < ::OptionParser
+    attr_reader :options
+    DEFAULT_OPTIONS = {
+      :sheet => nil,
+      :file => nil,
+    }
+
+    def initialize(args)
+      @options = DEFAULT_OPTIONS
+      opts = super() do |opts|
+        @help = opts
+
+        opts.banner =  "Usage: #{$0} [FILENAME]"
+
+        opts.separator "\n"
+
+        opts.on_tail("-h","--help", "Show this help") do
+          puts opts
+          exit 0
+        end
+
+        opts.on_tail("--version", "Show the version") do
+          require 'ss2json/version'
+          puts "#{$0} Version: #{SS2JSON::VERSION}"
+          exit 0
+        end
+
+      end
+      opts.parse!(args)
+
+      if args.size > 1
+        file = args.first
+        File.file?(file) or die("File #{file} not found")
+        @options[:file] = File.open(file)
+      else
+        @options[:file] = $stdin
+      end
+    end
+
+    def die(msg)
+      $stderr.puts msg
+      $stderr.puts @help
+      exit -1
+    end
+  end
+
+end

data/lib/ss2json-commands/constants.rb

@@ -0,0 +1,132 @@
+
+
+require 'ss2json/command'
+require 'ss2json/converter'
+require 'optparse'
+require 'json'
+
+class Constants < SS2JSON::Command
+
+  def self.name
+    "constants"
+  end
+
+  def self.description
+    "Convert a spreadsheet to a json hash where the keys are in one column and the values are in another column"
+  end
+
+  def initialize(options)
+    options = Options.new(options).options
+    output = Converter.new(options).process
+    puts JSON.pretty_generate(output)
+  end
+
+  class Options < OptionParser
+    attr_reader :options
+    DEFAULT_OPTIONS = {
+      :first_row => 1,
+      :sheet => nil,
+      :file => nil,
+      :key_column => 1,
+      :value_column => 2,
+      :converter => {
+        :show_null => false,
+        :dont_convert => false,
+        :ignored_values => [],
+        :downcase_first_letter => true
+      }
+
+    }
+
+    def initialize(args)
+      @options = DEFAULT_OPTIONS
+      @help = nil
+      super() do |opts|
+        @help = opts
+
+        opts.banner =  "Usage: #{$0} FILENAME [options]"
+
+        opts.on("-s", "--sheet SHEET_NAME", "Use other that the first table") do |sheet|
+          @options[:sheet] = sheet
+        end
+
+        opts.on("-r", "--first-row ROW_NUMBER", "Set the first row") do |row|
+          die("Can't understand the row #{row}. Use a number") unless row =~ /\A\d*\z/
+          @options[:first_row] = row.to_i
+        end
+
+
+        opts.on("-k", "--key-column COLUMN_NUMBER", "Column where the keys are (Default to 1)") do |column|
+          die("Can't understand the column #{column}. Use a number") unless column =~ /\A\d*\z/
+            @options[:key_column] = column.to_i
+        end
+
+        opts.on("-a", "--value-column COLUMN_NUMBER", "Column where the values are (Default to 2)") do |column|
+          die("Can't understand the column #{column}. Use a number") unless column =~ /\A\d*\z/
+            @options[:value_column] = column.to_i
+        end
+
+        opts.separator "\nData options:"
+
+        opts.on("-i", "--ignore-value VALUE", "Ignore the fields with that value. Could be use several times") do |t|
+          @options[:converter][:ignored_values] << t
+        end
+
+        opts.on("-b", "--include-blank", "Generate a json with the values included in the ignore list") do |t|
+          @options[:converter][:show_null] = true
+        end
+
+        opts.on("-d", "--disable-conversion", "Disable the conversion from floats to integers") do
+          @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 "\n"
+
+        opts.on_tail("-h","--help", "Show this help") do
+          puts opts
+          exit 0
+        end
+
+        opts.on_tail("--version", "Show the version") do
+          puts "#{File.basename($0)} Version: #{SS2JSON::VERSION}"
+          exit 0
+        end
+
+      end.parse!(args)
+
+      if args.size == 1
+        @options[:file] = args.first
+        unless File.file?(@options[:file])
+          $stderr.puts "File #{@options.file} not found"
+          exit -5
+        end
+      else
+        die("Incorrect number of parameters")
+      end
+    end
+
+    def die(msg)
+      $stderr.puts msg
+      $stderr.puts @help
+      exit -1
+    end
+  end
+
+  class Converter < SS2JSON::Converter
+    def process
+      hash = {}
+      each_row do |row|
+        key = @doc.cell(row, @options[:key_column])
+        value = @doc.cell(row, @options[:value_column])
+        hash[key] = value
+      end
+      @content = SS2JSON::RowConverter.new(hash, @options[:converter])
+      @content
+    end
+  end
+end

data/lib/ss2json-commands/humanize.rb

@@ -0,0 +1,72 @@
+
+
+
+
+require 'ss2json/command'
+require 'optparse'
+
+class Humanize < SS2JSON::Command
+
+  def self.name
+    "humanize"
+  end
+
+  def self.description
+    "Pretty print and sort (keys) on json"
+  end
+
+  def initialize(options)
+    options = Options.new(options).options
+    if options[:file]
+      exec "python -mjson.tool < '#{options[:file]}'"
+    else
+      exec "python -mjson.tool"
+    end
+  end
+
+  class Options < ::OptionParser
+    attr_reader :options
+    DEFAULT_OPTIONS = {
+      :sheet => nil,
+      :file => nil,
+    }
+
+    def initialize(args)
+      @options = DEFAULT_OPTIONS
+      opts = super() do |opts|
+        @help = opts
+
+        opts.banner =  "Usage: #{$0} [FILENAME]"
+
+        opts.separator "\n"
+        opts.separator "\tThis tool use python -mjson.tool So you need python to be installed\n"
+
+        opts.on_tail("-h","--help", "Show this help") do
+          puts opts
+          exit 0
+        end
+
+        opts.on_tail("--version", "Show the version") do
+          require 'ss2json/version'
+          puts "#{$0} Version: #{SS2JSON::VERSION}"
+          exit 0
+        end
+
+      end
+      opts.parse!(args)
+
+      if args.size > 1
+        file = args.first
+        File.file?(file) or die("File #{file} not found")
+        @options[:file] = file
+      end
+    end
+
+    def die(msg)
+      $stderr.puts msg
+      $stderr.puts @help
+      exit -1
+    end
+  end
+
+end