ppjson 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzI1OTEwNTg4ZDUwYWEwODhiOGEwNDEwYzQxODkzZTIzN2VmNmEzNA==
+    NTc1ZGQ1NmY0ODlhMGFjMTg1YWRjNTVjZjc0NzU1ODQ2MGE4N2M5ZQ==
   data.tar.gz: !binary |-
-    OGQ2N2U4Y2I0ODY0NGFhMzRkZmJlMTgzMTYzNDNhNjZjNDEwNDZmYQ==
+    NzFjMzgxMzA1N2RlOTMzZjkwOGJiMzVkMjA2YTcwNGNhMDhhN2M3Ng==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    Y2IwZmZlNjkzMTZjMDBmODFkYjI3NTgwMTBkZjBkMGNmZDA0ZTdlZTA0OGE3
-    NGM0NmVhOWEzMDE0MDAxNzQ2YTliNzUzZDM5YWNhZDgzMzMxZDRjNzJhODBj
-    Mjg5NGY0ZmY3NGNmOTcwNjNkNDY2OTgzYjViNWI3NWMwYzdmYzc=
+    YzUzNzJhNDkwNDlkOGZhZjJiMzJiZjI4MjgwZjM4NmEwY2FmZmQyNTBhNjhm
+    MTk2ZWMyMDNlMDJhNmU3NThiOTY3NWY1YjgxOTAzODRhNzZjNmU5YTQ0ZjZi
+    ZjRhOTNmYmY5N2JhOTNlYmFhMzk1NzNiMmRkNTg5NTUzNzY0NDM=
   data.tar.gz: !binary |-
-    OTAzZjFkZTkxMTBiMGYxM2IwNzI3ZjA2Y2JlYmFlYzJiYTM2M2JkNGQzYzEy
-    MDA3MmMyMjFkMDQyMzMzNDZjYjVjMWU0Mzk3YzU2MjhlOTYyNGIyODFiZGE2
-    ZjRmNWNlYWMxZTcyOTIzMTZiZTQwMjIyNDY5Y2JmYTY1NTRmMTA=
+    ZDA3ZDdmZjdhMTU1NjYzNGYzN2UzMjJiNTZlZGY3ZTdjOTdjM2JiYzMzMTFi
+    N2ViNzI3YjVmNGY1YjcwYWM4Mjc3Mjk4MTViNmZiOTk2OWM2MmVmOTk5NDMx
+    MGJhMDQzNDkwZGEzMDU0MmNmZGUxODYwMGI4ZmZjMjQ5NDlmMjU=

data/README.md

@@ -1,6 +1,6 @@
 # Ppjson
 
-TODO: Write a gem description
+Pretty print your JSON on the command-line the easy way.
 
 ## Installation
 
@@ -18,7 +18,51 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Pretty printing your JSON on the command line has never been easier:
+
+```
+ppjson '{"a":"b"}'
+```
+
+If another command returns some JSON for you:
+
+```
+curl http://mydomain.com/blah.json | ppjson
+```
+
+Do you have some JSON in a file? See a pretty printed version of it:
+
+```
+ppjson -f my_file.json
+```
+
+Or maybe you want to pretty print the contents of the file and then update the file with the pretty printed version:
+
+```
+ppjson -f -i my_file.json
+```
+
+Perhaps you already have some pretty printed JSON in a file, but you want to pass it as an argument to some other command, so you need to un-pretty print it:
+
+```
+ppjson -f -u my_file.json
+```
+
+You can even store your un-pretty printed version back into the file for later:
+
+```
+ppjson -f -u -i my_file.json
+```
+
+Get some help with:
+
+```
+ppjson -h
+```
+
+It's easier to remember than `python -mjson.tool` and it won't annoyingly reorder your keys for you.
+
+If you're using RVM just dump it into your global gemset to have it available everywhere.
 
 ## Contributing
 

data/TODO.txt

@@ -1,9 +1,21 @@
-- write a decent readme
-- stop using an unreleased escort that points at filesystem
-- try it out when installing at the top level
+- stop using an unreleased escort that points at filesystem                      DONE
+- try it out when installing at the top level                                    DONE
+- add a summary and description                                                  DONE
+- ppjson --file - to read json from a file, format it and spit it out to STDOUT                         DONE
+- ppjson --file --inline - to read json from a file, format it and overwrite the file with it           DONE
+- ppjson --file --backwards - take json from file which is presumably pretty already and unprettify it  DONE
+
+
+- write a decent readme             DONE
+- do a bunch of specs
+- do an integration test if can figure out a nice way of doing that
 - try it out with binstubs in another project
-- think about if it needs any arguments at all
+- up the version
+- release
+- blog about the current design to handle the different options interacting in different ways nicely
 
-- ppjson --file - to read json from a file, format it and spit it out to STDOUT
-- ppjson --file --inline - to read json from a file, format it and overwrite the file with it
-- ppjson --file --backwards - take json from file which is presumably pretty already and unprettify it
+- up the version of escort to one with depends support
+- do the dependencies between options
+- up the version
+- update readme
+- release

data/bin/ppjson

@@ -6,8 +6,17 @@ require 'ppjson'
 Escort::App.create do |app|
   app.version Ppjson::VERSION
 
+  app.summary "Pretty print JSON on the command-line"
+  app.description "Pretty print JSON strings by piping or passing them as arguments. It will preserve the ordering of your keys."
+
   app.requires_arguments
 
+  app.options do |opts|
+    opts.opt :file, "Read the JSON from a file", :short => '-f', :long => '--file', :type => :boolean, :default => false
+    opts.opt :inline, "Overwrite the file with the pretty JSON (only make sense with the --file option)", :short => '-i', :long => '--inline', :type => :boolean, :default => false, :depends_on => [:file]
+    opts.opt :undo, "Take pretty printed JSON from file and unprettify it (only make sense with the --file option)", :short => '-u', :long => '--undo', :type => :boolean, :default => false, :depends_on => [:file]
+  end
+
   app.action do |options, arguments|
     Ppson::Commands::PrettyPrintJson.new(options, arguments).execute
   end

data/data/test1.json

@@ -0,0 +1 @@
+{"a":"b","c":"d"}

data/data/test2.json

@@ -0,0 +1 @@
+{"1":"2","4":"5"}

data/lib/ppjson/arguments.rb

@@ -0,0 +1,22 @@
+module Ppson
+  class Arguments
+    include Enumerable
+
+    attr_reader :arguments, :options
+
+    def initialize(arguments, options)
+      @arguments = arguments
+      @options = options
+    end
+
+    def each(&block)
+      arguments.each do |argument|
+        block.call(argument_instance(argument, options))
+      end
+    end
+
+    def argument_instance(argument_data, options)
+      raise "Must be implemented in child class"
+    end
+  end
+end

data/lib/ppjson/arguments_decorator.rb

@@ -0,0 +1,24 @@
+module Ppson
+  class ArgumentsDecorator
+    attr_reader :arguments, :options
+
+    def initialize(arguments, options)
+      @arguments = arguments
+      @options = options
+    end
+
+    def decorate
+      options[:file] ? file_arguments : json_arguments
+    end
+
+    private
+
+    def file_arguments
+      FileArguments.new(arguments, options)
+    end
+
+    def json_arguments
+      JsonArguments.new(arguments, options)
+    end
+  end
+end

data/lib/ppjson/commands/pretty_print_json.rb

@@ -2,22 +2,10 @@ module Ppson
   module Commands
     class PrettyPrintJson < ::Escort::ActionCommand::Base
       def execute
-        arguments.each do |argument|
-          hash = from_json(argument.to_s)
-          $stdout.puts MultiJson.dump(hash, :pretty => true)
+        ArgumentsDecorator.new(arguments, command_options).decorate.each do |argument|
+          argument.process
         end
       end
-
-      private
-
-      def from_json(json)
-        MultiJson.load(json)
-      rescue MultiJson::LoadError => e
-        $stderr.puts "Invalid JSON string (don't forget to quote your strings e.g. '{\"abc\":\"def\"}'):"
-        $stderr.puts e.message
-        $stderr.puts "#{json}"
-        exit(1)
-      end
     end
   end
 end

data/lib/ppjson/file_argument.rb

@@ -0,0 +1,35 @@
+module Ppson
+  class FileArgument
+    attr_reader :filepath, :options
+
+    def initialize(filepath, options)
+      @filepath = filepath
+      @options = options
+    end
+
+    def process
+      with_contents do |contents|
+        writer.write(contents, :pretty => prettify?)
+      end
+    end
+
+    private
+
+    def with_contents(&block)
+      contents = reader.read
+      block.call(contents) if contents
+    end
+
+    def reader
+      @reader ||= FileJsonReader.new(filepath)
+    end
+
+    def writer
+      @writer ||= (options[:inline] ? FileJsonWriter.new(filepath) : StdoutJsonWriter.new)
+    end
+
+    def prettify?
+      !options[:undo]
+    end
+  end
+end

data/lib/ppjson/file_arguments.rb

@@ -0,0 +1,7 @@
+module Ppson
+  class FileArguments < Arguments
+    def argument_instance(argument_data, options)
+      FileArgument.new(argument_data, options)
+    end
+  end
+end

data/lib/ppjson/file_json_reader.rb

@@ -0,0 +1,21 @@
+module Ppson
+  class FileJsonReader
+    attr_reader :filepath
+
+    def initialize(filepath)
+      @filepath = filepath
+    end
+
+    def read
+      contents = nil
+      begin
+        File.open(filepath, 'r') do |file|
+          contents = file.readlines.join("")
+        end
+      rescue => e
+        Escort::Logger.error.warn("Error reading file #{filepath}")
+      end
+      contents
+    end
+  end
+end

data/lib/ppjson/file_json_writer.rb

@@ -0,0 +1,19 @@
+module Ppson
+  class FileJsonWriter
+    attr_reader :filepath
+
+    def initialize(filepath)
+      @filepath = filepath
+    end
+
+    def write(contents, options = {:pretty => false})
+      begin
+        File.open(filepath, 'w') do |file|
+          Ppjson::StreamJsonWriter.new(file).write(contents, :pretty => options[:pretty])
+        end
+      rescue => e
+        Escort::Logger.error.warn("Error writing file #{filepath}")
+      end
+    end
+  end
+end

data/lib/ppjson/json_argument.rb

@@ -0,0 +1,14 @@
+module Ppson
+  class JsonArgument
+    attr_reader :data, :options
+
+    def initialize(data, options)
+      @data = data
+      @options = options
+    end
+
+    def process
+      Ppjson::StreamJsonWriter.new.write(data, :pretty => true)
+    end
+  end
+end

data/lib/ppjson/json_arguments.rb

@@ -0,0 +1,7 @@
+module Ppson
+  class JsonArguments < Arguments
+    def argument_instance(argument_data, options)
+      JsonArgument.new(argument_data, options)
+    end
+  end
+end

data/lib/ppjson/stdout_json_writer.rb

@@ -0,0 +1,7 @@
+module Ppson
+  class StdoutJsonWriter
+    def write(contents, options = {:pretty => false})
+      Ppjson::StreamJsonWriter.new.write(contents, :pretty => options[:pretty])
+    end
+  end
+end

data/lib/ppjson/stream_json_writer.rb

@@ -0,0 +1,25 @@
+module Ppjson
+  class StreamJsonWriter
+    attr_reader :stream
+
+    def initialize(stream = $stdout)
+      @stream = stream
+    end
+
+    def write(json, options = {:pretty => true})
+      hash = from_json(json)
+      stream.puts MultiJson.dump(hash, options)
+    end
+
+    private
+
+    def from_json(json)
+      MultiJson.load(json)
+    rescue MultiJson::LoadError => e
+      Escort::Logger.error.error "Invalid JSON string (don't forget to quote your strings e.g. '{\"abc\":\"def\"}'):"
+      Escort::Logger.error.error e.message
+      Escort::Logger.error.warn "#{json}"
+      exit(1)
+    end
+  end
+end

data/lib/ppjson/version.rb

@@ -1,3 +1,3 @@
 module Ppjson
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/ppjson.rb

@@ -4,4 +4,19 @@ require 'multi_json'
 
 require "ppjson/version"
 
+require "ppjson/stream_json_writer"
+
+require "ppjson/file_json_reader"
+require "ppjson/stdout_json_writer"
+require "ppjson/file_json_writer"
+
+require "ppjson/file_argument"
+require "ppjson/json_argument"
+
+require "ppjson/arguments"
+require "ppjson/file_arguments"
+require "ppjson/json_arguments"
+
+require "ppjson/arguments_decorator"
+
 require "ppjson/commands/pretty_print_json"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ppjson
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Alan Skorkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escort
@@ -97,8 +97,20 @@ files:
 - Rakefile
 - TODO.txt
 - bin/ppjson
+- data/test1.json
+- data/test2.json
 - lib/ppjson.rb
+- lib/ppjson/arguments.rb
+- lib/ppjson/arguments_decorator.rb
 - lib/ppjson/commands/pretty_print_json.rb
+- lib/ppjson/file_argument.rb
+- lib/ppjson/file_arguments.rb
+- lib/ppjson/file_json_reader.rb
+- lib/ppjson/file_json_writer.rb
+- lib/ppjson/json_argument.rb
+- lib/ppjson/json_arguments.rb
+- lib/ppjson/stdout_json_writer.rb
+- lib/ppjson/stream_json_writer.rb
 - lib/ppjson/version.rb
 - ppjson.gemspec
 homepage: https://github.com/skorks/ppjson