class_from_son 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 53b0a1472f3977c2b06e85680263efdd69178894
-  data.tar.gz: 70b7f897adb5ee1b4ead08b90517eb2d1d412dad
+SHA256:
+  metadata.gz: f413bc7bc0f742bf3ac5f2cee734a668edf7d53f0a2e10718f852fdcce4cc901
+  data.tar.gz: 87ca04dc961b84b5fdb1779643e52d548e6c4f84899870c9f297802d498ce196
 SHA512:
-  metadata.gz: da824ddb560f2d64d476b3602d6e8c24c59f62ee62a367bf2b532813877d5151fdc45daae57ccc90aea77b3e9acf04054c1218e6fa5b60a4da284ba8ae9728f8
-  data.tar.gz: 640658471d76f8fa525f8057d6dc7a7159a56c093f498f165d1f570f9da6c0dce11f1e9c32ac09d0b016a2dcc2fd5d6a9575c58a481a3aae17a0ac9145b2173e
+  metadata.gz: aeff2562e7f122804a323348eebc4cfa6a3cadb89e3e5f4a9bb755d62e0f9890b07268fb483b71f4b245bf575300de88599903fdeb8c7ff4906bff96323fc936
+  data.tar.gz: 941bb7fbd059e1634d5dfd6fd5628b7e913c99883610b4e7a30c13ea29bd8d2610f766bd818ce53fee931e3e19167d1b61163fab9234151bdd09cc102664e15b

data/{README.txt → README.md}

@@ -7,19 +7,33 @@ If the SON looks to have a nested object structure (e.g. a Contact object looks
 Limitations :
 
 SON : will only process JSON
-Code : will only generate Ruby or Java
+Code : will only generate Ruby or Java (to generate Java using Lombok, use the :java_lombok symbol)
 
-Usage : require the gem, then invoke as follows : 
+Usage : require the gem, then invoke
 
-ClassFromSON.generate_from_file :ruby, a_file.json
+```
+require 'class_from_son'
+
+ClassFromSON.generate_from_file :ruby, "a_file.json"
 
 or
 
 ClassFromSON.generate :ruby, my_json_string, :json
+```
+
+or from the command line :
 
+```
+ruby -e "require 'class_from_son'; ClassFromSON.generate_from_file :ruby, 'a_file.json'"
+
+or
+
+ruby -e "require 'class_from_son'; ClassFromSON.generate :ruby, my_json_string, :json"
+```
 
 Method parameter explanations :
 
+```
 # Will generate classes from a SON file
 # Regardless of whether or not files are written, this will return an array of hashes; each hash represents a file, with two keys : :name for filename (without extension), and :contents for file contents
 #
@@ -29,9 +43,9 @@ Method parameter explanations :
 # make_file flag defaults to true; set to false if you do not want files to be created by this method
 # force_file flag is false; set to true if you wish to overwrite matching destination files (use with caution!)
 def ClassFromSON.generate_from_file(dest_lang, file, source_lang, make_file = true, force_file = false)
+```
 
-
-
+```
 # Will generate classes from a SON string
 # Regardless of whether or not files are written, this will return an array of hashes; each hash represents a file, with two keys : :name for filename (without extension), and :contents for file contents
 #
@@ -41,3 +55,4 @@ def ClassFromSON.generate_from_file(dest_lang, file, source_lang, make_file = tr
 # make_file flag defaults to true; set to false if you do not want files to be created by this method
 # force_file flag is false; set to true if you wish to overwrite matching destination files (use with caution!)
 def ClassFromSON.generate(dest_lang, source, source_lang, make_file = true, force_file = false)
+```

data/lib/class_from_SON.rb

@@ -1,11 +1,11 @@
 require "json"
-require "more-ruby"
+require "more_ruby"
 
 # A utility to convert an input file of string-object notation, e.g. JSON, XML, YAML, and generate code that looks like a class of your desired language
 
 class ClassFromSON
 
-	@@target_languages = [:java, :ruby]
+	@@target_languages = [:java, :java_lombok, :ruby]
 	@@input_modes = [:json]
 
 	def error(message)
@@ -55,7 +55,7 @@ class ClassFromSON
 	# Translate "Fixnum" into the desired output language
 	def convert_fixnum_to_type
 		case @language
-		when :java
+		when :java, :java_lombok
 			return "int"
 		else 
 			error_and_exit "Could not convert to output language #{@language}"
@@ -65,7 +65,7 @@ class ClassFromSON
 	# Translate "Fixnum" into the desired output language
 	def convert_float_to_type
 		case @language
-		when :java
+		when :java, :java_lombok
 			return "float"
 		else 
 			error_and_exit "Could not convert to output language #{@language}"
@@ -75,7 +75,7 @@ class ClassFromSON
 	# Translate "Fixnum" into the desired output language
 	def convert_boolean_to_type
 		case @language
-		when :java
+		when :java, :java_lombok
 			return "boolean"
 		else 
 			error_and_exit "Could not convert to output language #{@language}"
@@ -85,7 +85,7 @@ class ClassFromSON
 	# Translate "String" into the desired output language
 	def convert_string_to_type
 		case @language
-		when :java
+		when :java, :java_lombok
 			return "String"
 		else 
 			error_and_exit "Could not convert to output language #{@language}"
@@ -97,7 +97,7 @@ class ClassFromSON
 	def convert_array_to_type(value_types)
 		error_and_exit "Detected an array, but could not determine the type of its children; found #{value_types.size} possibilities" unless value_types.size == 1
 		case @language
-		when :java
+		when :java, :java_lombok
 			return "List<#{convert_ruby_type_to_type(value_types[0])}>"
 		else 
 			error_and_exit "Could not convert to output language #{@language}"
@@ -109,7 +109,7 @@ class ClassFromSON
 	def convert_hash_to_type(value_types)
 		error_and_exit "Detected a hash, but could not determine the type of its keys and values; found #{value_types.size} possibilities" unless value_types.size == 2
 		case @language
-		when :java
+		when :java, :java_lombok
 			return "HashMap<#{convert_ruby_type_to_type(value_types[0])}, #{convert_ruby_type_to_type(value_types[1])}>"
 		else 
 			error_and_exit "Could not convert to output language #{@language}"
@@ -119,7 +119,7 @@ class ClassFromSON
 	# Returns code representing the start of the class
 	def convert_custom_class_type(type)
 		case @language
-		when :java, :ruby
+		when :java, :java_lombok, :ruby
 			return type.capitalize_first_letter_only
 		else 
 			error_and_exit "Could not convert to output language #{@language}"
@@ -128,7 +128,7 @@ class ClassFromSON
 
 	def generate_top_level_name
 		case @language
-		when :java
+		when :java, :java_lombok
 			return "generatedFrom#{@mode.capitalize}"
 		when :ruby
 			return "generated_from_#{@mode}"
@@ -140,7 +140,7 @@ class ClassFromSON
 	# Returns an appropriately-formatted classname for the given name
 	def generate_classname(name)
 		case @language
-		when :java, :ruby
+		when :java, :java_lombok, :ruby
 			return name.capitalize_first_letter_only
 		else 
 			error_and_exit "Could not convert to output language #{@language}"
@@ -150,10 +150,10 @@ class ClassFromSON
 	# Returns an appropriately-formatted filename for the given name
 	def generate_filename(name)
 		case @language
-		when :java
+		when :java, :java_lombok
 			return name.capitalize_first_letter_only + @extension
 		when :ruby
-			return name.downcase + @extension # TODO convert camelcase to underbarised case
+			return name.snakecase + @extension
 		else 
 			error_and_exit "Could not convert to output language #{@language}"
 		end
@@ -161,7 +161,7 @@ class ClassFromSON
 
 	def set_file_extension_for_language
 		case @language
-		when :java
+		when :java, :java_lombok
 			@extension = ".java"
 		when :ruby
 			@extension = ".rb"
@@ -173,8 +173,31 @@ class ClassFromSON
 	# Returns code representing the start of the class
 	def generate_class_start(name)
 		case @language
-		when :java
-			start = "public class #{convert_custom_class_type(name)} {"
+		when :java, :java_lombok
+			start = <<-START
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class #{convert_custom_class_type(name)} {
+START
+		when :java_lombok # TODO
+			start = <<-START
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+@JsonInclude(Include.NON_NULL)
+@NoArgsConstructor // Need @NoArgsConstructor for JSON deserialisation
+@AllArgsConstructor // Need @AllArgsConstructor for @Builder
+@Builder
+@Getter
+@Setter
+public class #{convert_custom_class_type(name)} {
+START
 		when :ruby
 			start = "class #{convert_custom_class_type(name)}"
 		else 
@@ -186,7 +209,7 @@ class ClassFromSON
 	# Returns code representing the end of the class
 	def generate_class_end
 		case @language
-		when :java
+		when :java, :java_lombok
 			class_end = "}"
 		when :ruby 
 			class_end = "end"
@@ -199,6 +222,8 @@ class ClassFromSON
 	def generate_getter_and_setter(type, name)
 		lines = []
 		case @language
+		when :java_lombok
+			# do nothing - Lombok's raison d'etre is to avoid getters & setters
 		when :java
 			class_name = convert_custom_class_type(name)
 			lines << "\t"
@@ -218,7 +243,7 @@ class ClassFromSON
 	# Returns code representing each of the supplied attributes
 	def generate_code_from_attributes(attributes)
 		case @language
-		when :java
+		when :java, :java_lombok
 			return generate_java_code_from_attributes(attributes)
 		when :ruby
 			return generate_ruby_code_from_attributes(attributes)
@@ -232,7 +257,14 @@ class ClassFromSON
 		code = []
 		# Instance variables
 		attributes.each do |att|
-			code << "\tpublic #{convert_ruby_type_to_type(att[:type], att[:value_types])} #{att[:name]};"
+			if att[:name].include? "_"
+				snakecase_name = att[:name]
+				camelcase_name = att[:name].camelcase
+				code << "\t@JsonProperty(\"#{snakecase_name}\")"
+				code << "\tprivate #{convert_ruby_type_to_type(att[:type], att[:value_types])} #{camelcase_name};"
+			else 
+				code << "\tprivate #{convert_ruby_type_to_type(att[:type], att[:value_types])} #{att[:name]};"
+			end
 		end
 
 		#TODO constructor
@@ -372,10 +404,14 @@ class ClassFromSON
 			error_and_exit "Cannot parse input language #{@mode}; can only parse #{@@input_modes.join(", ")}"
 		end
 
+		# TODO other input languages, e.g. XML, YAML
 		case @mode
 		when :json
-			hash = JSON.parse(source)
-			# TODO other input languages, e.g. XML, YAML
+			begin
+				hash = JSON.parse(source)
+			rescue JSON::ParserError => e
+				error_and_exit "Could not parse supplied string as JSON. Error message : #{e.message}"
+			end
 		else
 			error_and_exit "Cannot parse mode #{@mode}"
 		end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class_from_son
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Richard Morrisby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-03 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies: []
 description: This gem will attempt to generate code of a class of an object representing
   the contents of a Serialised-Object-Notation (SON) string (or file). E.g. it will
@@ -16,21 +16,12 @@ description: This gem will attempt to generate code of a class of an object repr
 email: rmorrisby@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
-- LICENCE.txt
-- README.txt
-- build.rb
-- class_from_son.gemspec
+- README.md
 - lib/class_from_SON.rb
-- test/Address.java
-- test/GeneratedFromJson.java
-- test/PhoneNumbers.java
-- test/address.rb
-- test/generated_from_json.rb
-- test/phonenumbers.rb
 - test/test_class_from_son.rb
-- test/testjson.json
 homepage: https://rubygems.org/gems/class_from_son
 licenses:
 - MIT
@@ -50,10 +41,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Generates classes from SON (e.g. JSON)
+summary: Generates classes from Serialised-Object-Notation (e.g. JSON)
 test_files:
 - test/test_class_from_son.rb

data/LICENCE.txt

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2016 Richard Morrisby
-
-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/build.rb

@@ -1,51 +0,0 @@
-# Simple build script
-# Deletes the existing gem file (if present)
-# Uninstalls the gem
-# Builds the gem
-# Installs the new gem
-
-# Note : when calling system (or backticks, etc.) th enew process starts at the system default, not the current working directory.
-# Therefore we need to use a syntax of : system "cd #{gem_dir} && #{i_cmd}"
-
-# Run from this directory!
-
-gem_dir = Dir.getwd
-
-# Delete existing .gem files in the dir
-
-gemfiles = Dir.entries(gem_dir).collect {|q| q if q =~ /.gem$/}.compact
-
-gemfiles.each do |q| 
-	File.delete q
-	puts "Deleted #{q}"
-end
-
-gemfiles = Dir.entries(gem_dir).collect {|q| q if q =~ /.gem$/}.compact
-raise "Gem has not been deleted" unless gemfiles.size == 0
-
-# Uninstall, build, install
-gemspecs = Dir.entries(gem_dir).collect {|q| q if q =~ /.gemspec$/}.compact
-
-raise "Did not find a .gemspec in #{gem_dir}" if gemspecs.size < 1
-raise "Found more than one .gemspec in #{gem_dir}" if gemspecs.size > 1
-
-gemspec = gemspecs[0]
-
-gemname = File.basename(gemspec, File.extname(gemspec))
-
-u_cmd = "gem uninstall #{gemname}"
-system u_cmd
-
-b_cmd = "gem build #{gemspec}"
-system "cd #{gem_dir} && #{b_cmd}"
-
-gemfiles = Dir.entries(gem_dir).collect {|q| q if q =~ /.gem$/}.compact
-raise "Gem was not built" unless gemfiles.size == 1
-
-gemfile = gemfiles[0]
-raise "Gem file is not for the expected gem, expected a #{gemname} gem but found #{gemfile}" unless gemfile =~ /^#{gemname}/
-
-i_cmd = "gem install #{gemfile}"
-system "cd #{gem_dir} && #{i_cmd}"
-
-puts "Gem #{gemname} built & installed"

data/class_from_son.gemspec

@@ -1,15 +0,0 @@
-Gem::Specification.new do |s|
-  s.name        = 'class_from_son'
-  s.version     = '0.1.0'
-  s.licenses    = ['MIT']
-  s.summary     = "Generates classes from SON (e.g. JSON)"
-  s.description = "This gem will attempt to generate code of a class of an object representing the contents of a Serialised-Object-Notation (SON) string (or file). E.g. it will generate code of a object's class from some JSON."
-  s.authors     = ["Richard Morrisby"]
-  s.email       = 'rmorrisby@gmail.com'
-  s.files       = ["lib/class_from_SON.rb"]
-  s.homepage    = 'https://rubygems.org/gems/class_from_son'
-  s.required_ruby_version = '>=1.9'
-  s.files = Dir['**/**']
-  s.test_files = Dir["test/test*.rb"]
-  s.has_rdoc = true
-end

data/test/Address.java

@@ -1,38 +0,0 @@
-public class Address {
-	public String streetAddress;
-	public String city;
-	public String state;
-	public String postalCode;
-	
-	public String getStreetAddress() {
-		return streetAddress;
-	}
-	
-	public void setStreetAddress(String streetAddress) {
-		this.streetAddress = streetAddress;
-	}
-	
-	public String getCity() {
-		return city;
-	}
-	
-	public void setCity(String city) {
-		this.city = city;
-	}
-	
-	public String getState() {
-		return state;
-	}
-	
-	public void setState(String state) {
-		this.state = state;
-	}
-	
-	public String getPostalCode() {
-		return postalCode;
-	}
-	
-	public void setPostalCode(String postalCode) {
-		this.postalCode = postalCode;
-	}
-}

data/test/GeneratedFromJson.java

@@ -1,74 +0,0 @@
-public class GeneratedFromJson {
-	public String firstName;
-	public String lastName;
-	public boolean isAlive;
-	public int age;
-	public Address address;
-	public List<PhoneNumbers> phoneNumbers;
-	public List<String> children;
-	public String spouse;
-	
-	public String getFirstName() {
-		return firstName;
-	}
-	
-	public void setFirstName(String firstName) {
-		this.firstName = firstName;
-	}
-	
-	public String getLastName() {
-		return lastName;
-	}
-	
-	public void setLastName(String lastName) {
-		this.lastName = lastName;
-	}
-	
-	public boolean getIsAlive() {
-		return isAlive;
-	}
-	
-	public void setIsAlive(boolean isAlive) {
-		this.isAlive = isAlive;
-	}
-	
-	public int getAge() {
-		return age;
-	}
-	
-	public void setAge(int age) {
-		this.age = age;
-	}
-	
-	public Address getAddress() {
-		return address;
-	}
-	
-	public void setAddress(Address address) {
-		this.address = address;
-	}
-	
-	public List<PhoneNumbers> getPhoneNumbers() {
-		return phoneNumbers;
-	}
-	
-	public void setPhoneNumbers(List<PhoneNumbers> phoneNumbers) {
-		this.phoneNumbers = phoneNumbers;
-	}
-	
-	public List<String> getChildren() {
-		return children;
-	}
-	
-	public void setChildren(List<String> children) {
-		this.children = children;
-	}
-	
-	public String getSpouse() {
-		return spouse;
-	}
-	
-	public void setSpouse(String spouse) {
-		this.spouse = spouse;
-	}
-}

data/test/PhoneNumbers.java

@@ -1,20 +0,0 @@
-public class PhoneNumbers {
-	public String type;
-	public String number;
-	
-	public String getType() {
-		return type;
-	}
-	
-	public void setType(String type) {
-		this.type = type;
-	}
-	
-	public String getNumber() {
-		return number;
-	}
-	
-	public void setNumber(String number) {
-		this.number = number;
-	}
-}

data/test/address.rb

@@ -1,13 +0,0 @@
-class Address
-	attr_accessor :streetAddress
-	attr_accessor :city
-	attr_accessor :state
-	attr_accessor :postalCode
-
-	def initialize(streetAddress, city, state, postalCode)
-		@streetAddress = streetAddress
-		@city = city
-		@state = state
-		@postalCode = postalCode
-	end
-end

data/test/generated_from_json.rb

@@ -1,21 +0,0 @@
-class Generated_from_json
-	attr_accessor :firstName
-	attr_accessor :lastName
-	attr_accessor :isAlive
-	attr_accessor :age
-	attr_accessor :address
-	attr_accessor :phoneNumbers
-	attr_accessor :children
-	attr_accessor :spouse
-
-	def initialize(firstName, lastName, isAlive, age, address, phoneNumbers, children, spouse)
-		@firstName = firstName
-		@lastName = lastName
-		@isAlive = isAlive
-		@age = age
-		@address = address
-		@phoneNumbers = phoneNumbers
-		@children = children
-		@spouse = spouse
-	end
-end

data/test/phonenumbers.rb

@@ -1,9 +0,0 @@
-class PhoneNumbers
-	attr_accessor :type
-	attr_accessor :number
-
-	def initialize(type, number)
-		@type = type
-		@number = number
-	end
-end

data/test/testjson.json

@@ -1,28 +0,0 @@
-{
-  "firstName": "John",
-  "lastName": "Smith",
-  "isAlive": true,
-  "age": 25,
-  "address": {
-    "streetAddress": "21 2nd Street",
-    "city": "New York",
-    "state": "NY",
-    "postalCode": "10021-3100"
-  },
-  "phoneNumbers": [
-    {
-      "type": "home",
-      "number": "212 555-1234"
-    },
-    {
-      "type": "office",
-      "number": "646 555-4567"
-    },
-    {
-      "type": "mobile",
-      "number": "123 456-7890"
-    }
-  ],
-  "children": [],
-  "spouse": null
-}