class_from_son 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5740fbc390fbbac552526431b7f7c4aa1039482ed8c412e93f4ad17c6095c1cc
-  data.tar.gz: e0bbffad8e12988912e6c7958cf17f1ef8de88106530df49755d6f781b7aab4a
+  metadata.gz: 454e1aeddc02a92ce61a486b46b82c9843c4a030e3acf3e11c82161c4059926c
+  data.tar.gz: bc60bfad91c5fc55003bc46032f3895bb884217f0e2a2f6e43747bd6a587f3ea
 SHA512:
-  metadata.gz: a273fec4c6db2ca18253ad15c145f796dd8f0bd1ccd2ad6bb1213e061359fa272e784518689614f091ebf0b6c74fa6a9a6a528b18406cc45eb715c0cdd579e76
-  data.tar.gz: ae82fefbded46c38a84125f97b4cd89b1fa551972ec0bb56a407e1d81f83ff79a69aa66357288c78c878d134d538bc8feb67aec35e0f122e961a2bccec64d109
+  metadata.gz: d8cd190dcaff59b3c252093ec4dce5289e44ada71e21e358c4e5ac41bcab0a8753c0570712ea1bf4c0ae48144a0894d5f6e0669a8d41ed82d5118bf44c542ecf
+  data.tar.gz: 50959148d2c3212298f13aaf00c81bda79cf78d75708ba72fda514fc742c466bc934ee5ab09a6d9015270b54bcc8df2b94826074931d502f53ad2c161eab98f9

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 → 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,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"
@@ -174,7 +174,30 @@ class ClassFromSON
 	def generate_class_start(name)
 		case @language
 		when :java
-			start = "public class #{convert_custom_class_type(name)} {"
+			start = <<-START
+
+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
 			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,14 +222,20 @@ 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)
+			# 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 
@@ -218,7 +247,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 +261,15 @@ 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};"
+				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
 		end
 
 		#TODO constructor

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class_from_son
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Richard Morrisby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-23 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
@@ -20,7 +20,7 @@ extra_rdoc_files:
 - README.md
 files:
 - README.md
-- lib/class_from_son.rb
+- lib/class_from_SON.rb
 - test/test_class_from_son.rb
 homepage: https://rubygems.org/gems/class_from_son
 licenses:
@@ -41,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Generates classes from Serialised-Object-Notation (e.g. JSON)