jun 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70a404db6997b3aa8f1a682cfaac1d401e5a78aa2c6344645aed5819f9a7c617
-  data.tar.gz: 6ef4729b48e1f780a2004515c00a2ee6efbea77cade3522d942d05f602b509b8
+  metadata.gz: febb60185e9d61a52eb783ec6052f39a35b7a41afca6bf27cf8db4bea718536f
+  data.tar.gz: 8c4068f3c9093bc6b9184d1e9eeda93e06ff4ba11bf826c4dec93feb218efc73
 SHA512:
-  metadata.gz: fa512bde19df4fb617e5d49f6336433cff2ed31ba3dcfba942ed4473b8136a943ff92afcf0fb0a9dcf3f9ebc795f796393e0340a23bbfec183f7987cab90b841
-  data.tar.gz: 5bf62a8d2e2cfaedfce5435b44bc54388f2792b48459b028436c4baf40c8971a9bb6a53c3e63eda0126087142da5742cee470cb69890c50c2d23af228f883cad
+  metadata.gz: '0957dea84721aec8cbb82eeef95d7516c5862960683086686ee6b1ee2e0fae69ff4dbf72d145530d174f9220cd8e384206160a1264a9eba5eeaf334d51bd8674'
+  data.tar.gz: 5e90b858218ba802b04d5d7752f227947493b0c65243437faf8757147c726815794dd6f921521ce438b03ffc66883152379988b4b05058ad70276879c6d26e0d

data/lib/jun/action_dispatch/routing/welcome.html.erb

@@ -21,6 +21,19 @@
         text-align: center;
       }
 
+      .button {
+        background-color: #fc7e70;
+        color: #fff;
+        margin: 0 0.2rem;
+        padding: 0.5rem 0.75rem;
+        border-radius: 3px;
+        text-decoration: none;
+      }
+
+      .docs-links {
+        margin: 1.5rem 0;
+      }
+
       .sunspot {
         width: 100px;
         height: 100px;
@@ -35,6 +48,11 @@
     <div class="root">
       <div class="sunspot"></div>
       <h1>Welcome to Jun!</h1>
+      <p>Get started by checking out the guide or reading up on the docs.</p>
+      <div class="docs-links">
+        <a class="button" href="https://www.rubydoc.info/gems/jun/<%= Jun::VERSION %>#getting-started">Getting Started</a>
+        <a class="button" href="https://www.rubydoc.info/gems/jun/<%= Jun::VERSION %>">Documentation</a>
+      </div>
       <small>Jun v<%= Jun::VERSION %> | Ruby v<%= RUBY_VERSION %> (<%= RUBY_PLATFORM %>)</small>
     </div>
   </body>

data/lib/jun/active_support/core_ext/array/access.rb

@@ -1,26 +1,32 @@
 # frozen_string_literal: true
 
 class Array
+  # Returns the second element in the array.
   def second
     self[1]
   end
 
+  # Returns the third element in the array.
   def third
     self[2]
   end
 
+  # Returns the fourth element in the array.
   def fourth
     self[3]
   end
 
+  # Returns the fifth element in the array.
   def fifth
     self[4]
   end
 
+  # Returns the third-to-last element in the array.
   def third_to_last
     self[-3]
   end
 
+  # Returns the second-to-last element in the array.
   def second_to_last
     self[-2]
   end

data/lib/jun/active_support/core_ext/array/conversion.rb

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 
 class Array
+  # Converts the array to a comma-separated sentence.
+  #
+  #   ["one", "two", "three"].to_sentence                 #=> "one, two and three"
+  #   ["left", "right"].to_sentence(last_delimiter: "or") #=> "left or right"
+  #   [].to_sentence                                      #=> ""
+  #
+  # @param delimiter [String] the delimiter value for connecting array elements.
+  # @param last_delimiter [String] the connecting word for the last array element.
   def to_sentence(delimiter: ", ", last_delimiter: "and")
     return "" if none?
     return self.first if one?

data/lib/jun/active_support/core_ext/hash/transformation.rb

@@ -1,18 +1,28 @@
 # frozen_string_literal: true
 
 class Hash
+  # Returns a new hash with all keys converted to strings.
+  #
+  #   { name: "Tom", age: 50 }.stringify_keys #=> {"name"=>"Tom", "age"=>50}
   def stringify_keys
     transform_keys(&:to_s)
   end
 
+  # Modifies the hash in place to convert all keys to strings.
+  # Same as +stringify_keys+ but modifies +self+.
   def stringify_keys!
     transform_keys!(&:to_s)
   end
 
+  # Returns a new hash with all keys converted to symbols.
+  #
+  #   { "name" => "Tom", "age" => 50 }.symbolize_keys #=> {:name=>"Tom", :age=>50 }
   def symbolize_keys
     transform_keys { |key| key.to_sym rescue key }
   end
 
+  # Modifies the hash in place to convert all keys to symbols.
+  # Same as +symbolize_keys+ but modifies +self+.
   def symbolize_keys!
     transform_keys! { |key| key.to_sym rescue key }
   end

data/lib/jun/active_support/core_ext/string/access.rb

@@ -1,14 +1,38 @@
 # frozen_string_literal: true
 
 class String
+  # Returns a character at the given integer of the string. The first character
+  # would be returned for index 0, the second at index 1, and onward. If a range
+  # is given, a substring conaining the characters within the range of the given
+  # indicies is returned. If a Regex is provided, the matching substring is returned.
+  #
+  #   string = "smoki"
+  #   string.at(0)      # => "s"
+  #   string.at(1..3)   # => "mok"
+  #   string.at(-2)     # => "k"
+  #   string.at(/oki/)  # => "oki"
   def at(position)
     self[position]
   end
 
+  # Returns a substring from the given position (index) to the end of the string.
+  # If the position is negative, the starting point is counted from the end of the string.
+  #
+  #   string = "smoki"
+  #   string.from(0)  # => "smoki"
+  #   string.from(3)  # => "ki"
+  #   string.from(-2) # => "ki"
   def from(position)
     self[position, length]
   end
 
+  # Returns a substring from the beginning of the string to the given position (index).
+  # If the position is negative, the ending point is counted from the end of the string.
+  #
+  #   string = "smoki"
+  #   string.to(0)  # => "s"
+  #   string.to(3)  # => "smok"
+  #   string.to(-2) # => "smok"
   def to(position)
     position += size if position.negative?
     position = -1 if position.negative?

data/lib/jun/active_support/core_ext/string/inflector.rb

@@ -68,6 +68,11 @@ module Inflector
                   'equipment'
                  ]
 
+  # Returns the plural form of the string.
+  #
+  #   "task".pluralize    #=> "tasks"
+  #   "octopus".pluralize #=> "octopi"
+  #   "fish".singularize  #=> "fish"
   def pluralize
     return self if UNCHANGEABLE.include? self
 
@@ -82,6 +87,11 @@ module Inflector
     self.sub(pattern, replacement)
   end
 
+  # Returns the singular form of the string.
+  #
+  #   "tasks".singularize  #=> "task"
+  #   "octopi".singularize #=> "octopus"
+  #   "fish".singularize   #=> "fish"
   def singularize
     return self if UNCHANGEABLE.include? self
 
@@ -96,6 +106,10 @@ module Inflector
     self.sub(pattern, replacement)
   end
 
+  # Converts a string to under_score format.
+  #
+  #   "HelloThere".underscore #=> "hello_there"
+  #   "Foo::BarBaz".underscore #=> "foo/bar_baz"
   def underscore
     gsub(/::/, '/').
     gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
@@ -104,6 +118,10 @@ module Inflector
     downcase
   end
 
+  # Converts a string to CamelCase format.
+  #
+  #   "hello_there".camelize #=> "HelloThere"
+  #   "foo/bar_baz".camelize #=> "Foo::BarBaz"
   def camelize
     sub(/^[a-z\d]*/) { |match| match.capitalize }.
     gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.

data/lib/jun/active_support/dependencies.rb

@@ -8,6 +8,8 @@ module Jun
       attr_accessor :autoload_paths
       self.autoload_paths = []
 
+      # Returns the filepath for a given filename if the file exists
+      # in one of the directories specified in +autoload_paths+.
       def find_file(filename)
         autoload_paths.each do |path|
           filepath = File.join(path, "#{filename}.rb")

data/lib/jun/application.rb

@@ -15,6 +15,8 @@ module Jun
       @routes ||= Jun::ActionDispatch::Routing::RouteSet.new
     end
 
+    # Initializes the Jun application.
+    # @return [Boolean] +true+ if successful, +false+ if already initialized.
     def initialize!
       return false if initialized? || Jun.application.nil?
 
@@ -38,6 +40,8 @@ module Jun
       @initialized = true
     end
 
+    # Checks whether the Jun application has been initialized.
+    # @return [Boolean] +true+ if initialized, +false+ if not initialized.
     def initialized?
       !!@initialized
     end

data/lib/jun/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jun
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jun
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Zoran
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack