aerials 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfeb52aadb8fbd51583379067ea0917411b66038
-  data.tar.gz: e47d08335dc26865205bfae7f40735cfd96bd4fb
+  metadata.gz: dc24615c4e2f6e21790e36209bb2a4a2716df8d0
+  data.tar.gz: c2054bb6d80b95f598ffb4277e6316c17d59cc33
 SHA512:
-  metadata.gz: 3f8cd1663a37bfcccfa7a43175f562324873fc183b94492c09bfe219df8bd764692f140c8c2cc4758549505ea109c487e5d626043c50c7c0d16cdf190a38744b
-  data.tar.gz: a88207e5f1cd99a4681356353a1cccfbb6101e95f81ad9b3c96d92814d37e273dd442df08bec811c0018890564ca7892cc4a11a1c1cd3025687c12cccfc944ab
+  metadata.gz: 226875170e3e5070e6535578995cde8967dd1e42820dd205e08da42ef58bd0cb55c51d002466012418d5b928e97c407f6a56295050651e59df22871d5a4ce16a
+  data.tar.gz: d2de277775e553156063f7243dd0dc3b517b3b0c7f055a4bdb97eebc5fe5cf5c7dda5650556a4785f94de0e1ac9373948b3c38596aaa75010dfb3d37d1a95058

data/README.md

@@ -1,6 +1,6 @@
 # Aerials
 
-TODO: Write a gem description
+Gem generates constant JSON. As consequence, you can MD5 it and this will remain the same.
 
 ## Installation
 
@@ -18,7 +18,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### JSON generation rules:
+- No extra spaces
+- Always use double quotes for keys and array/hash values ("")
+- Always add slashes to double quotes (replace " with \")
+- Always use UTF8 (TODO)
+- Always sort by keys on each level (arrays should be sorted by values)
+- Always sort as strings
+
+### Example:
+
+    struct = {
+        array: [2, '1'],
+        hash: {
+            'a' => '1'
+        },
+        a: 2,
+    }
+    Aerials.create_json struct
+
+    # will eq
+    # '{"a":"2","array":["1","2"],"hash":{"a":"1"}}'
+
+You can exclude fields:
+
+    Aerials.create_json(struct, exclude: [:controller])
+
+Or use default Rails exclusion:
+
+    Aerials.create_json_rails struct
+    # equals to:
+    Aerials.create_json struct, exclude: [:action, :controller, :key]
 
 ## Contributing
 

data/lib/aerials.rb

@@ -13,10 +13,10 @@ class Aerials
     if struct.is_a? Hash
       struct = struct.clone
       exclude.each { |key| struct.delete(key) }
-      struct = struct.sort
+      struct = struct.sort rescue struct
       "{#{ struct.map{|elem| "#{to_val elem[0]}:#{to_val elem[1]}"}.join(',') }}"
     elsif struct.is_a? Array
-      struct = struct.clone.sort
+      struct = struct.clone.map!{|el| el.is_a?(Symbol)? el.to_s : el }.sort
       "[#{ struct.map{|elem| to_val elem }.join(',') }]"
     elsif struct.respond_to? :to_s
       struct.to_s
@@ -31,9 +31,9 @@ class Aerials
     if elem.is_a?(Hash) || elem.is_a?(Array)
       self.create_json(elem)
     elsif elem.is_a?(String)
-      "'#{ elem.to_s.gsub("'","\\'") }'"
+      "\"#{ elem.to_s.gsub('"','\"') }\""
     else
-      "'#{ elem.to_s }'"
+      "\"#{ elem.to_s }\""
     end
   end
 end

data/lib/aerials/version.rb

@@ -1,3 +1,3 @@
 class Aerials
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/aerials_spec.rb

@@ -8,7 +8,7 @@ describe Aerials do
         'symbol keys & vals' => {:key_a => :val_a, :key_b => :val_b}
     }.each do |type, struct|
       it "processes plain hash with #{type} correctly" do
-        expect(Aerials.create_json struct).to eq "{'key_a':'val_a','key_b':'val_b'}"
+        expect(Aerials.create_json struct).to eq '{"key_a":"val_a","key_b":"val_b"}'
       end
     end
 
@@ -17,18 +17,18 @@ describe Aerials do
         'symbol vals' => [:val_a, :val_b]
     }.each do |type, struct|
       it "processes plain array with #{type} correctly" do
-        expect(Aerials.create_json struct).to eq "['val_a','val_b']"
+        expect(Aerials.create_json struct).to eq '["val_a","val_b"]'
       end
     end
 
     it 'sorts hash keys' do
       struct = {'b' => 'c', 'c' => 'z', 'a' => 'g'}
-      expect(Aerials.create_json struct).to eq "{'a':'g','b':'c','c':'z'}"
+      expect(Aerials.create_json struct).to eq '{"a":"g","b":"c","c":"z"}'
     end
 
     it 'sorts array' do
       struct = ['b', 'c', 'a']
-      expect(Aerials.create_json struct).to eq "['a','b','c']"
+      expect(Aerials.create_json struct).to eq '["a","b","c"]'
     end
 
     it 'processes nested hash' do
@@ -37,7 +37,7 @@ describe Aerials do
                  'key_e' => 'val_e' }
       expect(
           Aerials.create_json struct
-      ).to eq "{'key_a':'val_a','key_b':{'key_c':'val_c','key_d':'val_d'},'key_e':'val_e'}"
+      ).to eq '{"key_a":"val_a","key_b":{"key_c":"val_c","key_d":"val_d"},"key_e":"val_e"}'
     end
 
     it 'processes nested array' do
@@ -46,29 +46,29 @@ describe Aerials do
                  'key_e' => 'val_e' }
       expect(
           Aerials.create_json struct
-      ).to eq "{'key_a':'val_a','key_b':['val_c','val_d'],'key_e':'val_e'}"
+      ).to eq '{"key_a":"val_a","key_b":["val_c","val_d"],"key_e":"val_e"}'
     end
 
     it 'quotes numbers in array' do
       struct = [1, 2]
-      expect(Aerials.create_json struct).to eq "['1','2']"
+      expect(Aerials.create_json struct).to eq '["1","2"]'
     end
 
     it 'quotes numbers' do
       struct = { 1 => 2, 3 => 4 }
-      expect(Aerials.create_json struct).to eq "{'1':'2','3':'4'}"
+      expect(Aerials.create_json struct).to eq '{"1":"2","3":"4"}'
     end
 
     it 'excludes keys' do
       struct = {'b' => 'c', 'c' => 'z', 'a' => 'g', 'd' => 'e'}
-      expect(Aerials.create_json struct, exclude: ['c', 'd']).to eq "{'a':'g','b':'c'}"
+      expect(Aerials.create_json struct, exclude: ['c', 'd']).to eq '{"a":"g","b":"c"}'
     end
 
     it 'excludes controller & action for Rails' do
       struct = { action: 'action',
                  controller: 'controller',
                  data: 'some data'}
-      expect(Aerials.create_json_rails struct).to eq "{'data':'some data'}"
+      expect(Aerials.create_json_rails struct).to eq '{"data":"some data"}'
     end
   end
 end

data/spec/json_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'json'
+
+describe Aerials do
+  context 'create_json' do
+    {
+        'string array' => [
+            ['val_a', 'val_b'],
+            ['val_a', 'val_b']
+        ],
+        'symbol array' => [
+            [:val_a, :val_b],
+            ['val_a', 'val_b']
+        ],
+        'mixed array' => [
+            ['val_a', :val_b],
+            ['val_a', 'val_b']
+        ],
+        'string hash' => [
+            {'b' => 'c', 'c' => 'z', 'a' => 'g'},
+            {'b' => 'c', 'c' => 'z', 'a' => 'g'}
+        ],
+        'hash with symbol keys' => [
+            {:b => 'c', :c => 'z', :a => 'g'},
+            {'b' => 'c', 'c' => 'z', 'a' => 'g'}
+        ],
+        'symbol hash' => [
+            {:b => :c, :c => :z, :a => :g},
+            {'b' => 'c', 'c' => 'z', 'a' => 'g'}
+        ],
+        'nested' => [
+            {:b => :c, 'c' => [:z, 'y'], :a => {:g => :d}},
+            {'b' => 'c', 'c' => ['y', 'z'], 'a' => {'g' => 'd'}},
+        ]
+    }.each do |type, struct|
+      it "creates parsable json from #{type}" do
+        expect(JSON.parse(Aerials.create_json struct[0])).to eq struct[1]
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aerials
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Roman Exempliarov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,7 @@ files:
 - lib/aerials.rb
 - lib/aerials/version.rb
 - spec/aerials_spec.rb
+- spec/json_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/appelsin/aerials
 licenses:
@@ -95,4 +96,5 @@ specification_version: 4
 summary: Sorted json generator. Use it for hash signing.
 test_files:
 - spec/aerials_spec.rb
+- spec/json_spec.rb
 - spec/spec_helper.rb