roda-tags 0.1.2 → 0.2.0

data/Rakefile

@@ -1,28 +1,24 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rake/testtask'
+
+RuboCop::RakeTask.new
 
 Rake::TestTask.new(:spec) do |t|
-  t.libs << "spec"
-  t.libs << "lib"
+  t.libs << 'spec'
+  t.libs << 'lib'
   t.test_files = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :spec
+task default: %i[rubocop coverage]
+
+desc 'alias for spec task'
+task test: :spec
 
-desc "Run specs with coverage"
+desc 'Run specs with coverage'
 task :coverage do
   ENV['COVERAGE'] = '1'
   Rake::Task['spec'].invoke
-  # `open coverage/index.html` # if OSX
-end
-
-desc 'Run Rubocop report'
-task :rubocop do
-  res = `which rubocop`
-  if res != ""
-    `rubocop -f html -o ./rubocop/report.html lib/`
-    # `open rubocop/report.html` # if OSX
-  else
-    puts "\nERROR: 'rubocop' gem is not installed or available. Please install with 'gem install rubocop'."
-  end
 end

data/lib/core_ext/blank.rb

@@ -1,33 +1,34 @@
+# frozen_string_literal: true
 
 # reopening Object class
 class Object
-  # An object is blank if it's false, empty, or a whitespace string.
-  # For example, +false+, '', '   ', +nil+, [], and {} are all blank.
+  # Checks if an object is blank or not.
+  # An object is blank if it does not respond to empty? or if it returns false on calling empty?.
+  # If it does not respond to empty?, then it will check if the object is truthy.
   #
-  # This simplifies
+  # This simplifies `!address || address.empty?` to `address.blank?`
   #
-  #   !address || address.empty?
+  # @return [true, false] false if object responds to empty? and
+  #          empty? returns false, true otherwise
   #
-  # to
-  #
-  #   address.blank?
-  #
-  # @return [true, false]
   def blank?
     respond_to?(:empty?) ? !!empty? : !self
   end
-  
-  # An object is present if it's not blank.
+
+  # Returns true if the object is not blank.
+  # An object is considered not blank if it has meaningful content.
+  #
+  # @return [true, false] true if object is not blank, false otherwise
   #
-  # @return [true, false]
   def present?
     !blank?
   end
-  
-  # Returns the receiver if it's present otherwise returns +nil+.
-  # <tt>object.presence</tt> is equivalent to
+
+  # Returns self if the object is present, otherwise returns nil.
+  #
+  # @return [Object, nil] self if present?, nil otherwise
   #
-  #    object.present? ? object : nil
+  # `object.presence` is equivalent to `object.present? ? object : nil`
   #
   # For example, something like
   #
@@ -39,7 +40,6 @@ class Object
   #
   #   region = params[:state].presence || params[:country].presence || 'US'
   #
-  # @return [Object]
   def presence
     self if present?
   end
@@ -55,7 +55,6 @@ class NilClass
   def blank?
     true
   end
-  
 end
 
 # reopening FalseClass class
@@ -68,7 +67,6 @@ class FalseClass
   def blank?
     true
   end
-  
 end
 
 # reopening TrueClass class
@@ -81,7 +79,6 @@ class TrueClass
   def blank?
     false
   end
-  
 end
 
 # reopening Array class
@@ -92,8 +89,7 @@ class Array
   #   [1,2,3].blank? # => false
   #
   # @return [true, false]
-  alias_method :blank?, :empty?
-  
+  alias blank? empty?
 end
 
 # reopening Hash class
@@ -104,55 +100,60 @@ class Hash
   #   { key: 'value' }.blank?  # => false
   #
   # @return [true, false]
-  alias_method :blank?, :empty?
-  
+  alias blank? empty?
 end
 
 # reopening String class
 class String
   BLANK_RE = /\A[[:space:]]*\z/
 
-  # A string is blank if it's empty or contains whitespaces only:
+  # Returns true if the string consists entirely of whitespace characters
+  #
+  # @return [true, false] true if string is empty or only whitespace, false otherwise
+  #
+  # @example A basic example
   #
   #   ''.blank?       # => true
   #   '   '.blank?    # => true
   #   "\t\n\r".blank? # => true
   #   ' blah '.blank? # => false
   #
-  # Unicode whitespace is supported:
+  # @example Unicode whitespace support
   #
   #   "\u00a0".blank? # => true
   #
-  # @return [true, false]
   def blank?
     BLANK_RE === self
   end
-  
 end
 
 # reopening Numeric class
-class Numeric #:nodoc:
-  # No number is blank:
+class Numeric # :nodoc:
+  # No numeric value is blank:
+  #
+  # @return [false]
+  #
+  # @example A basic example
   #
   #   1.blank? # => false
   #   0.blank? # => false
   #
-  # @return [false]
   def blank?
     false
   end
-  
 end
 
 # reopening Time class
-class Time #:nodoc:
-  # No Time is blank:
+class Time # :nodoc:
+  # No Time is blank
+  #
+  # @return [false]
+  #
+  # @example A basic example
   #
   #   Time.now.blank? # => false
   #
-  # @return [false]
   def blank?
     false
   end
-  
 end

data/lib/core_ext/hash.rb

@@ -1,23 +1,40 @@
-# :stopdoc: 
+# frozen_string_literal: false
+
+# :stopdoc:
 class Hash
-  
   # remove any other version of #to_html_attributes
   undef_method :to_html_attributes if method_defined?(:to_html_attributes)
-  
+
+  # Converts a hash into HTML attribute string representation.
+  #
+  # @param empties [Boolean, nil] If provided and not nil, will exclude keys with blank values
+  #
+  # @return [String] HTML attribute string with keys sorted alphabetically
+  #
+  # @example
+  #   {class: 'button', id: 'submit'}.to_html_attributes #=> 'class="button" id="submit"'
+  #   {name: nil, id: 'test'}.to_html_attributes(true) #=> 'id="test"'
+  #
   def to_html_attributes(empties = nil)
-    hash = self.dup
+    hash = dup
     hash.reject! { |_k, v| v.blank? } unless empties.nil?
     out = ''
-    hash.keys.sort.each do |key|  # NB!! sorting output order of attributes alphabetically
+    hash.keys.sort.each do |key| # NB!! sorting output order of attributes alphabetically
       val = hash[key].is_a?(Array) ? hash[key].join('_') : hash[key].to_s
       out << "#{key}=\"#{val}\" "
     end
     out.strip
   end
-  
-  
+
   unless method_defined?(:reverse_merge)
-    # Merges the caller into +other_hash+. For example,
+    # Performs a non-destructive reverse merge with another hash
+    # This is particularly useful for initializing an options hash with default values.
+    #
+    # @param other_hash [Hash] The hash to merge into
+    #
+    # @return [Hash] A new hash with other_hash merged into self
+    #
+    # @example A basic example
     #
     #   options = options.reverse_merge(size: 25, velocity: 10)
     #
@@ -25,23 +42,29 @@ class Hash
     #
     #   options = { size: 25, velocity: 10 }.merge(options)
     #
-    # This is particularly useful for initializing an options hash
-    # with default values.
     def reverse_merge(other_hash)
       other_hash.merge(self)
     end
   end
-  
+
   unless method_defined?(:reverse_merge!)
-    
-    # Destructive +reverse_merge+.
+    # Performs a destructive reverse merge with another hash.
+    # Modifies the original hash by merging in the provided hash while keeping existing values.
+    #
+    # @param other_hash [Hash] The hash to merge into self
+    #
+    # @return [Hash] The modified hash with other_hash merged in
+    #
+    # @example
+    #   options = { size: 10 }
+    #   options.reverse_merge!(size: 25, velocity: 10)
+    #   # => { size: 10, velocity: 10 }
+    #
     def reverse_merge!(other_hash)
       # right wins if there is no left
       merge!(other_hash) { |_key, left, _right| left }
     end
-    alias_method :reverse_update, :reverse_merge!
-    
+    alias reverse_update reverse_merge!
   end
-  
 end
 # :startdoc:

data/lib/core_ext/object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 
 # reopening Object class
 class Object
@@ -25,7 +26,6 @@ class Object
   #
   # @return [Object]
   def presence_in(another_object)
-    self.in?(another_object) ? self : nil
+    in?(another_object) ? self : nil
   end
-  
 end