wright 0.1.1 → 0.1.2

data/lib/wright/util/stolen_from_activesupport.rb

@@ -25,20 +25,19 @@
 #   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 #   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-module Wright #:nodoc:
+module Wright
   module Util
-    # Internal: Various methods copied verbatim from ActiveSupport in
-    #   order to keep dependencies to a minimum.
+    # @api private
+    # Various methods copied verbatim from ActiveSupport in
+    # order to keep dependencies to a minimum.
     module ActiveSupport
-      # Internal: Convert a CamelCased String to underscored,
-      #   lowercase form.
+      # Converts a CamelCased string to underscored, lowercase form.
       #
       # Changes '::' to '/' to convert namespaces to paths.
       #
-      # camel_cased_word - The String to be underscored.
-      #
-      # Examples
+      # @param camel_cased_word [String] the string to be converted
       #
+      # @example
       #   underscore("ActiveModel")
       #   # => "active_model"
       #
@@ -46,12 +45,13 @@ module Wright #:nodoc:
       #   # => "active_model/errors"
       #
       # As a rule of thumb you can think of underscore as the inverse
-      # of camelize, though there are cases where that does not hold:
+      # of camelize, though there are cases where that does not hold.
       #
+      # @example
       #   camelize(underscore("SSLError"))
       #   # => "SslError"
       #
-      # Returns the underscored String.
+      # @return [String] the underscored string
       def self.underscore(camel_cased_word)
         word = camel_cased_word.to_s.dup
         word.gsub!(/::/, '/')
@@ -62,15 +62,14 @@ module Wright #:nodoc:
         word
       end
 
-      # Internal: Convert an underscored_string to UpperCamelCase.
+      # Converts an underscored_string to UpperCamelCase.
       #
       # camelize will also convert '/' to '::' which is useful for
-      #   converting paths to namespaces.
-      #
-      # s - The String to be camelized.
+      # converting paths to namespaces.
       #
-      # Examples
+      # @param s [String] the string to be camelized
       #
+      # @example
       #   camelize("active_record")
       #   # => "ActiveRecord"
       #
@@ -78,25 +77,25 @@ module Wright #:nodoc:
       #   # => "ActiveRecord::Errors"
       #
       # As a rule of thumb you can think of camelize as the inverse of
-      # underscore, though there are cases where that does not hold:
+      # underscore, though there are cases where that does not hold.
       #
       #   camelize(underscore("SSLError"))
       #   # => "SslError"
       #
-      # Returns the camelized String.
+      # @return [String] the camelized string
       def self.camelize(s)
         s.to_s
           .gsub(/\/(.?)/) { "::#{Regexp.last_match[1].upcase}" }
           .gsub(/(?:^|_)(.)/) { Regexp.last_match[1].upcase }
       end
 
-      # Internal: Find a constant with the name specified in the
-      # argument string.
-      #
-      # camel_cased_word - The String name of the constant to find.
+      # Finds a constant with the name specified in the argument
+      # string.
       #
-      # Examples
+      # @param camel_cased_word [String] the name of the constant to
+      #   find
       #
+      # @example
       #   constantize("Module")
       #   # => Module
       #
@@ -105,8 +104,9 @@ module Wright #:nodoc:
       #
       # The name is assumed to be the one of a top-level constant, no
       # matter whether it starts with "::" or not. No lexical context
-      # is taken into account:
+      # is taken into account.
       #
+      # @example
       #   C = 'outside'
       #   module M
       #     C = 'inside'
@@ -114,9 +114,10 @@ module Wright #:nodoc:
       #     constantize("C") # => 'outside', same as ::C
       #   end
       #
-      # Returns the constant.
-      # Raises NameError if the constant name is not in CamelCase or
-      #   the constant is unknown.
+      # @return [Class] the constant
+      # @raise [NameError] if the constant name is not in CamelCase or
+      #   the constant is unknown
+      # @todo Replace this method with Module.const_get in Ruby 2.0.
       def self.constantize(camel_cased_word)
         names = camel_cased_word.split('::')
         names.shift if names.empty? || names.first.empty?
@@ -129,13 +130,13 @@ module Wright #:nodoc:
         c
       end
 
-      # Internal: Find a constant with the name specified in the
-      # argument string.
+      # Finds a constant with the name specified in the argument
+      # string.
       #
-      # camel_cased_word - The String name of the constant to find.
-      #
-      # Examples
+      # @param camel_cased_word [String] the name of the constant to
+      #   find
       #
+      # @example
       #   constantize("Module")
       #   # => Module
       #
@@ -144,8 +145,9 @@ module Wright #:nodoc:
       #
       # The name is assumed to be the one of a top-level constant, no
       # matter whether it starts with "::" or not. No lexical context
-      # is taken into account:
+      # is taken into account.
       #
+      # @example
       #   C = 'outside'
       #   module M
       #     C = 'inside'
@@ -153,9 +155,7 @@ module Wright #:nodoc:
       #     constantize("C") # => 'outside', same as ::C
       #   end
       #
-      # nil is returned when the name is not in CamelCase or the
-      # constant (or part of it) is unknown.
-      #
+      # @example
       #   safe_constantize("blargle")
       #   # => nil
       #
@@ -165,8 +165,8 @@ module Wright #:nodoc:
       #   safe_constantize("UnknownModule::Foo::Bar")
       #   # => nil
       #
-      # Returns the constant or nil if the name is not in CamelCase or
-      #   the constant is unknown.
+      # @return [Class, NilClass] the constant or nil if the name is
+      #   not in CamelCase or the constant is unknown
       def self.safe_constantize(camel_cased_word)
         constantize(camel_cased_word)
       rescue NameError => e
@@ -178,17 +178,16 @@ module Wright #:nodoc:
         raise unless uninitialized_constant_exception
       end
 
-      # Internal: Construct a regular expression that will match a
-      # constant part by part.
-      #
-      # camel_cased_word - The CamelCased String constant name.
+      # Constructs a regular expression that will match a constant
+      # part by part.
       #
-      # Examples
+      # @param camel_cased_word [String] the CamelCased constant name
       #
+      # @example
       #   const_regexp("Foo::Bar::Baz")
       #   # => "Foo(::Bar(::Baz)?)?"
       #
-      # Returns the String to be used as a regular expression.
+      # @return [String] the string to be used as a regular expression
       def self.const_regexp(camel_cased_word)
         parts = camel_cased_word.split('::')
         last  = parts.pop

data/lib/wright/util/user.rb

@@ -2,53 +2,49 @@ require 'etc'
 
 module Wright
   module Util
-    # Internal: Various user utility functions.
+    # Various user utility functions.
     module User
-      # Internal: Get a user's uid.
+      # Returns a user's uid.
       #
-      # user - The user name or uid.
-      #
-      # Examples
+      # @param user [String, Integer] the user's name or uid
       #
+      # @example
       #   Wright::Util::User.user_to_uid('root')
       #   # => 0
       #
       #   Wright::Util::User.user_to_uid(0)
       #   # => 0
       #
-      # Returns the integer uid of the given user or nil if user was
-      # nil.
+      # @return [Integer] the integer uid of the given user or nil if
+      #   user was nil
       def self.user_to_uid(user)
         return nil if user.nil?
         user.is_a?(String) ? Etc.getpwnam(user).uid : user.to_i
       end
 
-      # Internal: Get a group's gid.
-      #
-      # group - The group name or gid.
+      # Returns a group's gid.
       #
-      # Examples
+      # @param group [String, Integer] the group's name or gid
       #
+      # @example
       #   Wright::Util::User.group_to_gid('root')
       #   # => 0
       #
       #   Wright::Util::User.group_to_gid(0)
       #   # => 0
       #
-      # Returns the integer gid of the given group or nil if group was
-      # nil.
+      # @return [Integer] the integer gid of the given group or nil if
+      #   group was nil
       def self.group_to_gid(group)
         return nil if group.nil?
         group.is_a?(String) ? Etc.getgrnam(group).gid : group.to_i
       end
 
-      # Internal: Split a colon-separated owner string into owner and
-      #           group.
-      #
-      # owner - The owner string
+      # Splits a colon-separated owner string into owner and group.
       #
-      # Examples
+      # @param owner [String] the owner string
       #
+      # @example
       #   Wright::Util::User.owner_to_owner_group('foo:bar')
       #   # => ["foo", "bar"]
       #
@@ -58,10 +54,11 @@ module Wright
       #   Wright::Util::User.owner_to_owner_group(23)
       #   # => [23, nil]
       #
-      # Returns the owner and group. Returns nil if no group was
-      #   specified. Non-string owners are returned unmodified.
-      # Raises ArgumentError if the owner string contains more than
-      #   one colon.
+      # @return [Array<(String, String)>] the owner and group. Returns
+      #   nil if no group was specified. Non-string owners are
+      #   returned unmodified.
+      # @raise [ArgumentError] if the owner string contains more than
+      #   one colon
       def self.owner_to_owner_group(owner)
         group = nil
         return [owner, group] unless owner.is_a?(String)

data/lib/wright/version.rb

@@ -1,4 +1,4 @@
 module Wright # rubocop:disable Documentation
-  # Public: Current wright version
-  VERSION = '0.1.1'
+  # Current wright version
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wright
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sebastian Boehm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 10.4.2
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 0.8.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 0.8.7.6
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -283,3 +283,4 @@ test_files:
 - spec/util/file_spec.rb
 - spec/util/user_spec.rb
 - spec/util_spec.rb
+has_rdoc: