class_from_son 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a9c37e0f86b52f9b278a97fe1282d031ec1fd8bacc4697f45e039bf624d460b
-  data.tar.gz: f40619bf1ecbe6e9f2bbd1ec44c814d9eaef5efc1e81934ee4b2df2fb2d319a6
+  metadata.gz: 64442ffab338e5be82ed2a8dd9da60904777f17c6aa397a1c41f3a03617823cb
+  data.tar.gz: 9f6145f03094e312ed5efd05c23cd93e67a5112ddd920b177a4dd91383e2ba6f
 SHA512:
-  metadata.gz: 833ef78c9b05c1b5310507fad502551e1d8734aa77093cdf786c478d66404d960c1bd94447f3f0ca13a881bcc678be9e6758d2c88bde56899e2ade0f04b68467
-  data.tar.gz: d40049cc202f07ac2ed698f5f0ff0896264d50f0eda0980252c7b04cd03b9521335b49963b77895234cfc6a15de6218a90824877168ffdef0c1c87f67ee279a0
+  metadata.gz: a8e7f6a45207f44a91043bda76f45c367d116c8498466d51e6946b14057de66e39ced63717304abcb0bf86623d19510a4b32023e5f3822c950ff419e4b0c97a4
+  data.tar.gz: 49894af656eb32ac4ce2d68637bc4998d737a3b2d7d2ab2f2afaf335dfa1153c09b1e62d136bf43318da898a330f34be30a28b9b195d3deb61183034a4b72b62

data/README.md

@@ -7,9 +7,10 @@ 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
+
 ```
 require 'class_from_son'
 
@@ -21,6 +22,7 @@ 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'"
 
@@ -30,6 +32,7 @@ ruby -e "require 'class_from_son'; ClassFromSON.generate :ruby, my_json_string,
 ```
 
 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
@@ -52,4 +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

@@ -5,7 +5,7 @@ require "more_ruby"
 
 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,7 +150,7 @@ 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.snakecase + @extension
@@ -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"
@@ -178,6 +178,24 @@ class ClassFromSON
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+public class #{convert_custom_class_type(name)} {
+START
+		when :java_lombok
+			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
@@ -191,7 +209,7 @@ START
 	# 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"
@@ -204,14 +222,20 @@ START
 	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)
+			# This is safe even if the name is already in snakecase
+			field_name_for_getter = name.snakecase.pascalcase
+
+			name = name.camelcase if name.include? "_"
+				
 			lines << "\t"
-			lines << "\tpublic #{type} get#{class_name}() {"
+			lines << "\tpublic #{type} get#{field_name_for_getter}() {"
 			lines << "\t\treturn #{name};"
 			lines << "\t}"
 			lines << "\t"
-			lines << "\tpublic void set#{class_name}(#{type} #{name}) {"		
+			lines << "\tpublic void set#{field_name_for_getter}(#{type} #{name}) {"		
 			lines << "\t\tthis.#{name} = #{name};"
 			lines << "\t}"
 		else 
@@ -223,7 +247,7 @@ START
 	# 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)
@@ -237,11 +261,12 @@ START
 		code = []
 		# Instance variables
 		attributes.each do |att|
-			if att.contains "_"
+			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};"
+				code << "" # add a new line so that fields are separated & easier to read
 			else 
 				code << "\tprivate #{convert_ruby_type_to_type(att[:type], att[:value_types])} #{att[:name]};"
 			end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class_from_son
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Richard Morrisby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2021-02-03 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
@@ -22,7 +22,7 @@ files:
 - README.md
 - lib/class_from_SON.rb
 - test/test_class_from_son.rb
-homepage: https://rubygems.org/gems/class_from_son
+homepage: https://github.com/RMorrisby/class_from_son
 licenses:
 - MIT
 metadata: {}