rusty_json 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 586d28acc06307f6920e376bcae55b025ce42021
-  data.tar.gz: 6851dd830392776b050b8c14730267a5518e1066
+  metadata.gz: 8229cb337a37bcc8564b5a89faea33d555df6baf
+  data.tar.gz: a59744de5deffd9f5e4574c9d2851da6b57a7552
 SHA512:
-  metadata.gz: 40753f7dd3e28fec338b956250501a9bced6d0b60cced4ae1130328087725fd8ed6620e51a8b7298492a1c9b76a6cc1a587b8b67febb53e39ed675f3e1285338
-  data.tar.gz: a3810f86f425c2b341527a5f061bbe513ba846f28c22494f1d29b383332dcb1ee5849a03ece019f7edf7a42c76bb88fe842388c4fddb90165ea827f26730a412
+  metadata.gz: feb861a20062c7e8fec5dd896dbd3783215568e8730a2c4e2e943f074020fa14876de0ecc19ce00ad8462f550768786d03e7318e6dd2a04dd8672fc95f8f04ee
+  data.tar.gz: b83f60923de006bffe464f745bccb756a898950161712ef37c3635b5ff5a59fb77c4ea20dade8b721d296b5b22ae1022823fd666fef90b8892e00e67f22bfc39

data/lib/rusty_json/parser.rb

@@ -2,13 +2,27 @@ require 'json'
 require 'set'
 
 module RustyJson
+  # Parser is the base class that actually parses JSON into Rust structs
+  #
+  # Example:
+  # ```ruby
+  # name = 'Test'
+  # json = '{"hello": "world"}'
+  # parser = Parser.new(name, json)
+  # parser.parse
+  # ```
+
   class Parser
+    # BASE_TYPES are merely Rust base types that we use before adding our own
+    # Structs to them.
     BASE_TYPES = {
       String => 'String',
       Fixnum => 'i64',
       Float => 'f64',
     }
 
+    # @param name [String] the name of the returned root JSON struct
+    # @param json [String] the JSON string to parse into a Rust struct
     def initialize(name, json)
       @name = name
       @json = json
@@ -16,6 +30,8 @@ module RustyJson
       @structs = Set.new
     end
 
+    # parse takes the given JSON string and turns it into a string of
+    # Rust structs, suitable for use with rustc_serialize.
     def parse
       @parsed = JSON.parse(@json)
       if @parsed.is_a? Hash
@@ -27,6 +43,8 @@ module RustyJson
     private
 
     def parse_name(n)
+      n = n.split('_').collect(&:capitalize).join
+
       if @struct_names.include? n
         i = 2
         while @struct_names.include? "#{n}_#{i}"
@@ -48,10 +66,11 @@ module RustyJson
     end
 
     def parse_parts(name, values, struct)
+      name = name.gsub('-', '_').gsub(':', '_').gsub('__', '_')
       if values.is_a? Array
         struct = parse_array(name, values, struct)
       elsif values.is_a? Hash
-        n = parse_name(name.split('_').collect(&:capitalize).join)
+        n = parse_name(name)
         @struct_names << n
         s = possible_new_struct( parse_hash(n, values) )
         struct.add_value(name, s)

data/lib/rusty_json/rust_struct.rb

@@ -1,6 +1,16 @@
 module RustyJson
+  #RustyJson:L:RustStruct is the object that will be translated into
+  # a Rust struct.
+  #
+  # @!attribute name
+  #   @return [String] name of the struct
+  # @!attribute values
+  #   @return [Hash] sub objects in the struct
+  # @!attribute root
+  #   @return is this the root level JSON object?
+
   class RustStruct
-    attr_reader :name, :values
+    attr_reader :name, :values, :root
 
     @@types = {
       String => 'String',
@@ -8,7 +18,10 @@ module RustyJson
       Float => 'f64',
       Array => 'Vec',
     }
-
+    # @param name [String] the name of the returned struct
+    # @param root [Boolean] is this the root struct
+    #
+    # Root is used so that we can reset child structs when the to_s is finished
     def initialize(name, root = false)
       @root = root
       @printed = false
@@ -17,6 +30,9 @@ module RustyJson
       @structs = Set.new
     end
 
+    # reset must be called to print the struct again, as we don't want to
+    # repeatedly print the same struct when it occurs recursively in the
+    # input JSON
     def reset
       @printed = false
       @structs.each do |s|
@@ -24,6 +40,20 @@ module RustyJson
       end
     end
 
+    # Add Value is how we add keys to the resulting Struct
+    # We need a name and a type, and potentially a subtype
+    #
+    # For example:
+    # types could be String, Fixnum, or Array
+    # If the tyoe is Array, then we need the subtype of the array,
+    # is it an array of integers or strings?
+    #
+    # @param name [String] what is this key in the struct
+    # @param type [Class] What typs are we
+    # @param subtype [Class] What typs are we
+    #
+    # @return true
+
     def add_value(name, type, subtype = nil)
       if type.class == RustyJson::RustStruct || subtype.class == RustyJson::RustStruct
         struct = if type.class == RustyJson::RustStruct
@@ -41,21 +71,15 @@ module RustyJson
       else
         @values[name] = [type, subtype]
       end
+      true
     end
 
-    def required_structs
-      struct = ""
-      # binding.pry
-      @structs.to_a.each do |nested_struct|
-        struct << nested_struct.to_s + "\n"
-      end
-      struct
-    end
-
+    # two Rust structs are equal if all of their keys / value types are the same
     def == other
       self.values == other.values
     end
 
+    # to_s controlls how to display the RustStruct as a Rust Struct
     def to_s
       return "" if @printed
       @printed = true
@@ -83,6 +107,15 @@ struct #{@name} {
 
     private
 
+    def required_structs
+      struct = ""
+      # binding.pry
+      @structs.to_a.each do |nested_struct|
+        struct << nested_struct.to_s + "\n"
+      end
+      struct
+    end
+
     def self.add_type(name, value)
       @@types[name] = value
     end

data/lib/rusty_json/version.rb

@@ -1,3 +1,3 @@
 module RustyJson
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/lib/rusty_json.rb

@@ -2,7 +2,26 @@ require "rusty_json/version"
 require "rusty_json/parser"
 require "rusty_json/rust_struct"
 
+# RustyJson is a gem to support [Rust](https://www.rust-lang.org) development
+# when using JSON. For a deeply nested JSON object, one may create many
+# structs to define the syntax of the expected JSON. RustyJson merely
+# Aims to reduce that :)
+
 module RustyJson
+  # Example Usage:
+  #
+  # json = File.read('json_file.json')
+  # rust = RustyJson.parse(json)
+  # File.write('output_structs.rs', rust)
+  #
+  # In the above example, RustyJson will parse the JSON in the file:
+  # json_file.json and then you print the rust structs out to a Rust
+  # File.
+  #
+  # @param json [String] the name of the returned struct
+  # @param name [String] the JSON to parse
+  # @return String
+
   def self.parse(json, name = 'JSON')
     parser = Parser.new(name, json)
     parser.parse

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rusty_json
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Chris MacNaughton