ginny 0.5.0

data/lib/ginny/models/param.rb

@@ -0,0 +1,90 @@
+module Ginny
+  # Used to generate a function [parameter][2].
+  #
+  # [1]: http://ruby-for-beginners.rubymonstas.org/bonus/arguments_parameters.html
+  # [2]: https://ruby-doc.org/core-2.6.5/doc/syntax/methods_rdoc.html#label-Arguments
+  class Param
+
+    # Name of the param.
+    # @return [String]
+    attr_accessor :name
+    # Description of the param. [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) is supported.
+    # @return [String]
+    attr_accessor :description
+    # [Type](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#Declaring_Types) of the attribute.
+    # @return [String]
+    attr_accessor :type
+    # Default value for the Param.
+    # Set `optional` as `true` for a default `nil` value.
+    # @return [String]
+    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]
+    attr_accessor :optional
+    # If `true`, the param will be generated as a [keyword argument](https://bugs.ruby-lang.org/issues/14183).
+    # @return [Boolean]
+    attr_accessor :keyword
+
+    # Constructor for a Param. Use `create`, not `new`.
+    #
+    # @param [Hash<Symbol>] args
+    # @option args [String] :name
+    # @option args [String] :description
+    # @option args [String] :type
+    # @option args [Object] :default
+    # @option args [Boolean] :keyword (false)
+    # @option args [Boolean] :optional (false)
+    # @return [Ginny::Param]
+    def self.create(args = {})
+      p = Ginny::Param.new()
+      p.name        = args[:name]
+      p.description = args[:description]
+      p.type        = args[:type]
+      p.default     = args[:default]
+      p.keyword     = args[:keyword] || false
+      p.optional    = args[:optional] || false
+      return p
+    end
+
+    # @param array [Array<Hash>]
+    # @return [Array<Ginny::Param>]
+    def self.from_array(array)
+      return array.map { |p| self.create(p) }
+    end
+
+    # @return [String]
+    def render
+      parts = []
+      parts << @name
+      default = self.render_default_value()
+      if @keyword
+        parts << ":"
+        parts << (" " + default) if default
+      elsif default
+        parts << (" = " + default)
+      end
+      return parts.compact.join("").gsub(/\s+$/, "")
+    end
+
+    # @return [String,nil]
+    def render_default_value
+      # `nil` default value
+      return "nil" if self.optional
+      # No default value
+      return nil if self.default.nil?
+      # Add quotes to a String.
+      return (Ginny::QUOTE + self.default + Ginny::QUOTE) if self.type == "String" || self.default.is_a?(String)
+      # Add colon to a Symbol.
+      return ":#{self.default}" if self.type == "Symbol" || self.default.is_a?(Symbol)
+      # `to_s` should handle everything else.
+      return self.default.to_s
+    end
+
+    # @return [String]
+    def render_doc
+      return "# @param #{self.name} [#{self.type}] #{self.description}".strip
+    end
+
+  end
+end

data/lib/ginny/string/comment.rb

@@ -0,0 +1,19 @@
+# Monkeypatch some convenience methods in to the String class.
+class String
+  # Adds a comment string (`"# "`) after every newline in a string.
+  #
+  # @param indent_empty_lines [Boolean]
+  # @return [void]
+  def comment!(indent_empty_lines = true)
+    re = indent_empty_lines ? /^/ : /^(?!$)/
+    gsub!(re, "# ")
+  end
+
+  # Returns a copy of a string with a comment (`"# "`) after every newline in a string.
+  #
+  # @param indent_empty_lines [Boolean]
+  # @return [String]
+  def comment(indent_empty_lines = true)
+    dup.tap { |s| s.comment!(indent_empty_lines) }
+  end
+end

data/lib/ginny/string/indent.rb

@@ -0,0 +1,52 @@
+# Monkeypatch some convenience methods in to the String class.
+class String
+
+  # def titleize2(string)
+  #   words = self.split(" ")
+  #   skips = ["and", "of", "the", "in", "to", "over", "an", "a"]
+  #   words.each do |word|
+  #     if word == words[0] || !skips.include?(word)
+  #         element.capitalize!
+  #     end
+  #   end
+  #   answer = array.join(" ")
+  #   return answer
+  # end
+
+  # Same as {indent}, except it indents the receiver in-place.
+  #
+  # Returns the indented string, or `nil` if there was nothing to indent.
+  #
+  # @param amount [Integer] The level of indentation to add.
+  # @param indent_string [String] Defaults to tab if a tab is present in the string, and `" "` otherwise.
+  # @param indent_empty_lines [Boolean]
+  #
+  # @return [void]
+  def indent!(amount, indent_string = nil, indent_empty_lines = false)
+    indent_string = indent_string || self[/^[ \t]/] || " "
+    re = indent_empty_lines ? /^/ : /^(?!$)/
+    gsub!(re, indent_string * amount)
+  end
+
+  # Indents the lines in the receiver.
+  #
+  # The second argument, `indent_string`, specifies which indent string to
+  # use. The default is `nil`, which tells the method to make a guess by
+  # peeking at the first indented line, and fallback to a space if there is
+  # none.
+  #
+  # While `indent_string` is typically one space or tab, it may be any string.
+  #
+  # The third argument, `indent_empty_lines`, is a flag that says whether
+  # empty lines should be indented. Default is `false`.
+  #
+  # @param amount [Integer] The level of indentation to add.
+  # @param indent_string [String] Defaults to tab if a tab is present in the string, and `" "` otherwise.
+  # @param indent_empty_lines [Boolean]
+  #
+  # @return [String]
+  def indent(amount, indent_string = nil, indent_empty_lines = false)
+    dup.tap { |s| s.indent!(amount, indent_string, indent_empty_lines) }
+  end
+
+end

data/lib/ginny/symbolize.rb

@@ -0,0 +1,31 @@
+module Ginny
+  # Recursively convert keys in a Hash or Array to symbols.
+  #
+  # See:
+  # - [original code](https://avdi.codes/recursively-symbolize-keys/)
+  # - [array support](https://gist.github.com/neektza/8585746)
+  #
+  # @param arg [Hash,Array]
+  # @return [Hash,Array]
+  def self.symbolize_keys(arg)
+    if arg.is_a?(Hash)
+      arg.inject({}) do |result, (key, value)|
+        new_key = case key
+                  when String then key.to_sym()
+                  else key
+                  end
+        new_value = case value
+                    when Hash then symbolize_keys(value)
+                    when Array then symbolize_keys(value)
+                    else value
+                    end
+        result[new_key] = new_value
+        result
+      end
+    elsif arg.is_a?(Array)
+      arg.map { |e| symbolize_keys(e) }
+    else
+      arg
+    end
+  end
+end

data/lib/ginny/version.rb

@@ -0,0 +1,3 @@
+module Ginny
+  VERSION = "0.5.0".freeze
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: ginny
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Clay Dunston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Generate Ruby code.
+email:
+- dunstontc@gmail.com
+executables:
+- ginny
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".solargraph.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/docs
+- bin/setup
+- exe/ginny
+- ginny.gemspec
+- lib/ginny.rb
+- lib/ginny/error.rb
+- lib/ginny/load.rb
+- lib/ginny/mod.rb
+- lib/ginny/models/attr.rb
+- lib/ginny/models/class.rb
+- lib/ginny/models/func.rb
+- lib/ginny/models/param.rb
+- lib/ginny/string/comment.rb
+- lib/ginny/string/indent.rb
+- lib/ginny/symbolize.rb
+- lib/ginny/version.rb
+homepage: https://github.com/tcd/ginny
+licenses:
+- MIT
+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.0
+  changelog_uri: https://github.com/tcd/ginny/blob/master/CHANGELOG.md
+  yard.run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Generate Ruby code.
+test_files: []