jsontrim 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Levin Alexander
+
+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.rdoc

@@ -0,0 +1,18 @@
+= jsontrim
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Levin Alexander. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jsontrim"
+    gem.summary = %Q{remove unimportant elements from a json object}
+    gem.description = %Q{remove unimportant elements from a json object}
+    gem.email = "mail@levinalex.net"
+    gem.homepage = "http://github.com/levinalex/jsontrim"
+    gem.authors = ["Levin Alexander"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_dependency "json"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jsontrim #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/jsontrim.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jsontrim}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Levin Alexander"]
+  s.date = %q{2009-10-09}
+  s.description = %q{remove unimportant elements from a json object}
+  s.email = %q{mail@levinalex.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "jsontrim.gemspec",
+     "lib/jsontrim.rb",
+     "test/jsontrim_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/levinalex/jsontrim}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{remove unimportant elements from a json object}
+  s.test_files = [
+    "test/jsontrim_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end

data/lib/jsontrim.rb

@@ -0,0 +1,97 @@
+require 'json'
+
+# takes a JSON object, removes specified subtrees and trims arrays
+# returns a pretty printed string
+#
+#     before = <<-EOF
+#     { "foo": {
+#         "one": { "a": 1, "b": {"c": 2} },
+#         "two": "value",
+#         "three": { "b": [1,2,3] }},
+#       "bar": [1,2,3,4,5] }
+#     EOF
+#
+#     blacklist = [
+#       "foo:!two",   # delete the value before['foo']['two']
+#       "foo:*:!b",   # delete all the keys called "b" nested two levels under "foo"
+#       "bar:+"       # only keep the first element of the foo-list
+#     ]
+#
+#     after = JSONTrim.cut(before, :ignore => blacklist)
+#
+#      {
+#        "foo": {
+#          "two": ...,
+#          "three": {
+#            "b": [ ... ]
+#          },
+#          "one": {
+#            "a": 1,
+#            "b": { ... }
+#          }
+#        },
+#        "bar": [
+#          1,
+#          ...
+#        ]
+#      }
+#
+class JSONTrim
+
+  # prune the given JSON-string or ruby Hash according to
+  # the rules given in opts[:ignore]
+  #
+  def self.cut(obj, opts = {})
+    obj = JSON.parse(obj) if String === obj
+
+    (opts[:ignore] || []).each do |ignore_str|
+      ignoring = ignore_str.split(":")
+
+      obj = cutr(obj, ignoring)
+    end
+
+    js = JSON.pretty_generate(obj)
+    js = js.gsub('"IGN_HSH"', "{ ... }")
+    js = js.gsub('"IGN_ARY"', "[ ... ]")
+    js = js.gsub('"IGN"', "...")
+  end
+  
+  # recursively prune the current ruby object with the given rules
+  # replace pruned elements with marker strings
+  #
+  #   cutr( [1,2,3],         ["+"] )       #=> [ 1, "IGN" ]
+  #   cutr( {"a"=>{"b"=>3}}, ["!a"] )      #=> { "a" => "IGN_HSH" }
+  #   cutr( {"a"=>{"b"=>3}}, ["a", "!b"])  #=> { "a" => { "b" => "IGN" }}
+  #
+  def self.cutr(data, rules)
+    key, *rest = rules
+
+    if key =~ /^!(.*)/
+      name = $1
+
+      data[name] = case data[name]
+                     when Hash then "IGN_HSH"
+                     when Array then "IGN_ARY"
+                     else "IGN"
+                   end if data[name]
+    elsif key =~ /^\+$/
+      if Array === data
+        data = [data.first, "IGN"]
+      end
+    elsif key =~ /^\*$/
+      if Array === data
+        data = data.map { |elem| cutr(elem, rest) }
+      elsif Hash === data
+        data = data.inject({}) do |h,(k,v)| h[k] = cutr(v, rest); h end
+      end
+    else
+      name = key
+
+      if data[name] and not rest.empty?
+        data[name] = cutr(data[name], rest)
+      end
+    end
+
+    data
+  end
+end

data/test/jsontrim_test.rb

@@ -0,0 +1,95 @@
+require 'test_helper'
+
+class JsontrimTest < Test::Unit::TestCase
+  def assert_equal_ws(expected, actual)
+    expected = expected.gsub(/\s/, "")
+    actual = actual.gsub(/\s/,"")
+    assert_equal expected, actual
+  end
+
+  should "pass json through unchanged" do
+    assert_equal %Q({\n  "foo": "bar"\n}),
+                 JSONTrim.cut(%q({"foo": "bar"}))
+  end
+
+  should "ignore" do
+    assert_equal({"a" => 3, "b" => "IGN" },
+                 JSONTrim.cutr({ "a" => 3, "b" => 4 } , ["!b"]))
+    assert_equal({"a" => 3, "b" => "IGN_HSH" },
+                 JSONTrim.cutr({ "a" => 3, "b" => { "c" => 4 }} , ["!b"]))
+    assert_equal({"a" => 3, "b" => "IGN_ARY" },
+                 JSONTrim.cutr({ "a" => 3, "b" => [ 4 ] } , ["!b"]))
+  end
+
+  should "distinguish between arrays and hashes" do
+    assert_equal %Q({\n  "foo": { ... }\n}),
+                 JSONTrim.cut(%q({"foo" : { "bar": "fred"}}),  :ignore => ["!foo"])
+    assert_equal %Q({\n  "foo": [ ... ]\n}),
+                 JSONTrim.cut(%q({"foo" : [ "bar", "fred"]}),  :ignore => ["!foo"])
+    assert_equal %Q({\n  "foo": ...\n}),
+                 JSONTrim.cut(%q({"foo" : 3}),  :ignore => ["!foo"])
+  end
+
+  should "work for nested attributes" do
+    assert_equal %Q({\n  "foo": {\n    "bar": { ... }\n  }\n}),
+                 JSONTrim.cut(%q({"foo" : { "bar": {"f":3}}}), :ignore => ["foo:!bar"])
+
+    assert_equal %Q({\n  "foo": {\n    "bar": ...\n  }\n}),
+                JSONTrim.cut(%q({"foo" : { "bar": 3}}), :ignore => ["foo:!bar"])
+  end
+
+  should "not alter json if ignored thing does not exist" do
+    assert_equal %Q({\n  "foo": { ... }\n}),
+                 JSONTrim.cut(%q({"foo" : { "bar": "fred"}}),
+                   :ignore => ["!foo", "!doesnotexist", "foo:!doesnotexist"])
+  end
+
+  should "allow ignoring of subelements of arrays" do
+    assert_equal_ws %Q({"foo":[{"bar": { ... }},{"bar": ...}]}),
+                 JSONTrim.cut(%q({"foo" : [{ "bar": {"baz":3}}, {"bar":3}]}), :ignore => ["foo:*:!bar"])
+  end
+
+  should "allow ignoring of arrays" do
+    assert_equal %Q({\n  "foo": [\n    "bar",\n    ...\n  ]\n}),
+                 JSONTrim.cut(%q({"foo": ["bar", "baz", "fred"]}),
+                   :ignore => ["foo:+"])
+  end
+
+  should "pass a complex testcase" do
+    before = <<-EOF
+     { "foo": {
+          "one": { "a": 1, "b": {"c": 2} },
+          "two": "value",
+          "three": { "b": [1,2,3] }},
+       "bar": [1,2,3,4,5] }
+     EOF
+
+     blacklist = [
+       "foo:!two",
+       "foo:*:!b",
+       "bar:+"
+     ]
+
+     expected = <<-EOF
+{
+  "foo": {
+    "two": ...,
+    "three": {
+      "b": [ ... ]
+    },
+    "one": {
+      "a": 1,
+      "b": { ... }
+    }
+  },
+  "bar": [
+    1,
+    ...
+  ]
+}
+EOF
+
+     actual = JSONTrim.cut(before, :ignore => blacklist)
+     assert_equal expected.chomp, actual
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'jsontrim'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: jsontrim
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Levin Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: remove unimportant elements from a json object
+email: mail@levinalex.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- jsontrim.gemspec
+- lib/jsontrim.rb
+- test/jsontrim_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/levinalex/jsontrim
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: remove unimportant elements from a json object
+test_files: 
+- test/jsontrim_test.rb
+- test/test_helper.rb