ginny 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f3d8f40f9b5af0f032e1695e7c9300556041117fcc7086e0134ced0d35804cc
-  data.tar.gz: 18caec27a5b9e158b307e61b476006f03a56a40a73ad6bf22cd301307c74a2d8
+  metadata.gz: 5954674ccc9c88509fe6c907bfe4f23d13c6da96131a135c34374e7f6050f619
+  data.tar.gz: 31d45ba5e68259fd278950701c8caefc2799159f7dcaa265a25b2c3f19312af0
 SHA512:
-  metadata.gz: 5222da337829e94bf2752948fc964b0cbced3469358f2c95a99b2b84fb58dea5fcd391228987307ce9a8c9ecf6646bc851ecbabbf8481705d15c16071f4a5744
-  data.tar.gz: 2fe110d3e0a67d360c3b85ab3516062fe92d874a6c2aaea3839533c32149ee75c21081003ad5d5842a4a55deeb16d465a5343dc05378e62ebcb38ced5d31e2eb
+  metadata.gz: 454f12a2ebe56984619972409e81074799d2c94df3de76ce86ee2a13f105858c77c13797f9fc024e07b5c7f29e1df6e7d73f2a0f38f51c4a86474369a65724f8
+  data.tar.gz: 21d370801870b1223e3b470ded669a7149361228393917d1009a01166358c35aaaa19ce0b95564dd82413b4c39fd223cf6a08d165c30342d5b8fd683d3714b73

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 <!-- ## master (unreleased) -->
 
+## 0.6.0 (2019-12-14)
+
+### Added
+
+- Add `default_constructor` option for `Ginny::Class`, which will generate a method similar to [ActiveRecord::Base.create][create_method_link] for the class.
+
+[create_method_link]: https://apidock.com/rails/ActiveRecord/Persistence/ClassMethods/create 
+
 ## 0.5.4 (2019-12-09)
 
 ### Changed
@@ -42,7 +50,7 @@
 ### Added
 
 - Add [dry-rb/dry-inflector](https://github.com/dry-rb/dry-inflector) dependency.
-- Add `file_prefix` argument to `Ginny::Class` for String to prepend to the name of the generated file.
+- Add `file_prefix` option to `Ginny::Class` for a string to prepend to the name of the generated file.
 
 ### Changed 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ginny (0.5.4)
+    ginny (0.6.0)
       coolkit (~> 0.2.2)
       dry-inflector (~> 0.2.0)
 

data/README.md

@@ -44,6 +44,7 @@ name: Human
 description: This class models a person.
 modules: [MilkyWay, Earth]
 parent: Mammal
+default_constructor: true
 attrs:
 - name: Name
   type: String
@@ -51,7 +52,6 @@ attrs:
   description: Number of years the human has been alive.
   type: Integer
   read_only: true
-
 ```
 
 ```shell
@@ -68,6 +68,7 @@ data = {
   description: "This class models a person.",
   modules: ["MilkyWay", "Earth"],
   parent: "Mammal",
+  default_constructor: true,
   attrs: [
     { name: "name", type: "String" },
     { name: "age",  type: "Integer" read_only: true, description: "Number of years the human has been alive." },
@@ -90,6 +91,15 @@ module MilkyWay
       # Number of years the human has been alive.
       # @return [Integer]
       attr_reader :age
+
+      # @param params [Hash]
+      # @return [self]
+      def self.create(params = {})
+        h = Human.new
+        h.name = params[:name]
+        h.age = params[:age]
+        return h
+      end
     end
   end
 end
@@ -99,14 +109,17 @@ end
 
 ### `Ginny::Class`
 
-|      Name       |         Type         |                          Description                           |
-| --------------- | -------------------- | -------------------------------------------------------------- |
-| name (required) | `String`             | Name of the class.                                             |
-| description     | `String`             | Description of the class. [Markdown][markdown] is supported.   |
-| body            | `String`             | String to write into the body of the class.                    |
-| parent          | `String`             | Name of a class to inherit from. (Ex: `YourNewClass < Parent`) |
-| modules         | `Array<String>`      | List of modules to declare the class inside of                 |
-| attrs           | `Array<Ginny::Attr>` | An array of Attrs.                                             |
+|        Name         |         Type         |                                                   Description                                                   |
+| ------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------- |
+| name (required)     | `String`             | Name of the class.                                                                                              |
+| description         | `String`             | Description of the class. [Markdown][markdown] is supported.                                                    |
+| body                | `String`             | String to write into the body of the class.                                                                     |
+| parent              | `String`             | Name of a class to inherit from. (Ex: `YourNewClass < Parent`)                                                  |
+| modules             | `Array<String>`      | List of modules to declare the class inside of                                                                  |
+| default_constructor | `Boolean`            | If `true`, a method similar to [ActiveRecord::Base.create][create_method_link] will be generated for the class. |
+| attrs               | `Array<Ginny::Attr>` | An array of Attrs.                                                                                              |
+
+[create_method_link]: https://apidock.com/rails/ActiveRecord/Persistence/ClassMethods/create 
 
 ### `Ginny::Attr`
 

data/lib/ginny/models/class.rb

@@ -22,6 +22,9 @@ module Ginny
     # String to write into the body of the class.
     # @return [String]
     attr_accessor :body
+    # If `true`, a method similar to [ActiveRecord::Base.create](https://apidock.com/rails/ActiveRecord/Persistence/ClassMethods/create) will be generated for the class.
+    # @return [Boolean]
+    attr_accessor :default_constructor
     # String to prepend to the name of the generated file.
     # @return [String]
     attr_accessor :file_prefix
@@ -31,6 +34,8 @@ module Ginny
       self.attrs = []
       self.modules = []
       self.file_prefix = ""
+      self.body = ""
+      self.default_constructor = false
     end
 
     # Constructor for a Class. Use `create`, not `new`.
@@ -46,6 +51,7 @@ module Ginny
       c.attrs       = Ginny::Attr.from_array(args[:attrs]) if args[:attrs]&.is_a?(Array)
       c.body        = args[:body] unless args[:body].nil?
       c.file_prefix = args[:file_prefix] || ""
+      c.default_constructor = args[:default_constructor]
       return c
     end
 
@@ -67,7 +73,8 @@ module Ginny
       parts << (self.description&.length&.positive? ? self.description.comment.strip : nil)
       parts << (self.parent.nil? ? "class #{self.class_name()}" : "class #{self.class_name()} < #{self.parent}")
       parts << self.render_attributes()
-      parts << (self.body&.length&.positive? ? self.body.indent(2) : nil)
+      parts << self.render_body()
+      # parts << (self.body&.length&.positive? ? self.body.indent(2) : nil)
       parts << "end"
       if self.modules.length > 0
         body = parts.compact.join("\n").gsub(/([[:blank:]]+)$/, "")
@@ -76,6 +83,19 @@ module Ginny
       return parts.compact.join("\n").gsub(/([[:blank:]]+)$/, "")
     end
 
+    # @return [String,nil]
+    def render_body()
+      if self.body.length > 0
+        if self.default_constructor
+          return ("\n" + self.constructor() + "\n\n" + self.body).indent(2)
+        end
+        return self.body.indent(2)
+      end
+      # binding.pry
+      return "\n" + self.constructor().indent(2) if self.default_constructor
+      return nil
+    end
+
     # @return [String]
     def render_attributes()
       return nil unless self.attrs.length > 0
@@ -100,5 +120,19 @@ module Ginny
       return self.file_prefix + inflector.underscore(self.name) + ".rb"
     end
 
+    # @return [String]
+    def constructor()
+      char = self.name.chr.downcase
+      body = "#{char} = #{self.class_name}.new\n"
+      body << self.attrs.map { |a| "#{char}.#{a.name} = params[:#{a.name}]\n" }.join()
+      body << "return #{char}\n"
+      Ginny::Func.create({
+        name: "self.create",
+        return_type: "self",
+        params: [{ name: "params", type: "Hash", default: {} }],
+        body: body,
+      }).render()
+    end
+
   end
 end

data/lib/ginny/models/param.rb

@@ -20,10 +20,10 @@ module Ginny
     attr_accessor :default
     # If `true`, the default value will be `nil`.
     # FIXME: This is a workaround for the fact that that passing `nil` to `default` messes with conditionals. Not sure of a simpler way to do this.
-    # @return [Boolean]
+    # @return [Boolean] (false)
     attr_accessor :optional
     # If `true`, the param will be generated as a [keyword argument](https://bugs.ruby-lang.org/issues/14183).
-    # @return [Boolean]
+    # @return [Boolean] (false)
     attr_accessor :keyword
 
     # Constructor for a Param. Use `create`, not `new`.

data/lib/ginny/version.rb

@@ -1,3 +1,3 @@
 module Ginny
-  VERSION = "0.5.4".freeze
+  VERSION = "0.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ginny
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Clay Dunston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2019-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -191,7 +191,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/tcd/ginny
   source_code_uri: https://github.com/tcd/ginny
-  documentation_uri: https://www.rubydoc.info/gems/ginny/0.5.4
+  documentation_uri: https://www.rubydoc.info/gems/ginny/0.6.0
   changelog_uri: https://github.com/tcd/ginny/blob/master/CHANGELOG.md
   yard.run: yri
 post_install_message: