ecraft-extensions 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: af3834c6d1357bfa8ffe8806ebca6545b721b971
-  data.tar.gz: dd5b2a7a8163474d089fc226d2ab9ccd989f7f90
+SHA256:
+  metadata.gz: 3eedda0b4814dbad903bb2eb6cc867700c5c484a976a76b92a768c217b5d81b9
+  data.tar.gz: f635a3e21a66a8c0adaa62b2271870de37fe7ce1fb3251672ce2dc24afb3ff2c
 SHA512:
-  metadata.gz: 218f060f591e94b9c75c808050dc4910f414a752101b8cd8f8e9ed0a5f0165566b088a8177c8081d23d3c0bdbe04c8d2d9978e89058ea42e3cff64273fadd86e
-  data.tar.gz: 73a4dc85bce0cc233ec878d086b9e87870346e1685b6a0ba4bc172f51d00136914e0216821c1836e53bf0113e9402070a3d0779542b5703b2ff8023512e301d4
+  metadata.gz: bc5369edb007040cf10a5996cef0d821d8e81f8fc54a46c4f88d5d9fe9a83fac014b9cf0a4e0d22873b0e456edc7b9f23b30e9335f88ba92ba1a939caa273447
+  data.tar.gz: f7a63adbbb9abb5fb5c51276814aa3ee45f7ef898291248982e5687b66efee119e6da79fc4e04981ba2e54eb34fc3e171ef9a0e197e833a75871118be9e7afcf

data/.rubocop.yml

@@ -1,6 +1,8 @@
 AllCops:
   TargetRubyVersion: 2.3
   DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
 
 Layout/MultilineOperationIndentation:
   EnforcedStyle: indented
@@ -30,6 +32,11 @@ Style/Documentation:
   Enabled: false
 Style/Encoding:
   Enabled: false
+
+# Pending a Rubocop release with https://github.com/bbatsov/rubocop/issues/5245 included.
+Style/FormatStringToken:
+  Enabled: false
+
 Style/NumericPredicate:
   Enabled: false
 Style/FrozenStringLiteralComment:

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.5

data/.travis.yml

@@ -8,9 +8,8 @@ env:
  - "JRUBY_OPTS=--debug"
 
 before_install:
- - rm -rf ~/.rvm && if [ ! -d "$HOME/jruby-bin" ]; then mkdir -p ~/jruby-bin && pushd ~/jruby-bin && curl -o- -L https://s3.amazonaws.com/jruby.org/downloads/9.1.8.0/jruby-bin-9.1.8.0.tar.gz | tar xzf - --strip-components=1 && popd ; fi
+ - rm -rf ~/.rvm && if [ ! -d "$HOME/jruby-bin" ]; then mkdir -p ~/jruby-bin && pushd ~/jruby-bin && curl -o- -L https://s3.amazonaws.com/jruby.org/downloads/9.1.15.0/jruby-bin-9.1.15.0.tar.gz | tar xzf - --strip-components=1 && popd ; fi
  - export PATH="$HOME/jruby-bin/bin:$PATH"
  - gem install bundler
- - gem update --system
 
 cache: bundler

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ecraft-web-dsl-builtins.gemspec
 gemspec

data/README.md

@@ -4,7 +4,7 @@
 
 This code contains some useful extension methods to various Ruby classes.
 
-It also contains a few mixins in the `Ecraft::Extensions::Mixins` module.
+It also contains a mixin in the `Ecraft::Extensions::Mixins` module.
 
 ## Installation
 
@@ -24,25 +24,20 @@ Or install it yourself as:
 
 ## Usage
 
-Preferred approach:
-
 ```ruby
 # To load a specific extension:
 require 'ecraft/extensions/bigdecimal'
 ```
 
-Not-so-preferred approach:
+## Development
 
-```ruby
- # To load _all_ core extensions. USE WITH GREAT CARE, since this could cause conflicts with other libraries.
-require 'ecraft/extensions/all'
-```
+After checking out the repo, run `bin/setup` to install dependencies.
 
-## Development
+Then, run `rake spec` to run the tests.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
@@ -52,29 +47,27 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ecraft
 
 We strive to write documentation inline in [YARD](http://yardoc.org) format.
 
-### Previewing documentation locally
+### Preview documentation locally
+
 ```
 bundle exec yard server -r
 ```
 
-Check the locally served documentation at http://localhost:8808/
+Check the locally served documentation at [http://localhost:8808/](http://localhost:8808/).
 
 ### Releasing a new version
 
 - Bump the version in `version.rb`
 - Create the tag:
-
   ```
-  $ git release v1.0.x`
+  $ git release v1.0.x
   ```
-
-- Build the gemfile and push it to Rubygems.org:
-
+- Build the `.gem` file and push it to Rubygems.org:
   ```shell
   $ bundle exec rake build release
   ```
-
-- Generate the changelog (`cargo install changelog-rs && changelog-rs .`) and copy the relevant lines to [the releases page](https://github.com/ecraft/ecraft-extensions/releases).
+- Generate the changelog (`cargo install changelog-rs && changelog-rs .`) and
+  copy the relevant lines to [the releases page](https://github.com/ecraft/ecraft-extensions/releases).
 
 ### License
 

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'irb'
+require 'irb/completion' # easy tab completion
+
+require 'bundler/setup'
+Bundler.require
+
+$LOAD_PATH << './lib'
+
+require 'ecraft/extensions'
+require 'ecraft/extensions/bigdecimal'
+require 'ecraft/extensions/date'
+require 'ecraft/extensions/datetime'
+require 'ecraft/extensions/ostruct'
+require 'ecraft/extensions/string'
+require 'ecraft/extensions/time'
+
+puts "<#{$PROGRAM_NAME}> Starting IRB with each file in ecraft/extensions/ required"
+puts
+puts "<#{$PROGRAM_NAME}> To try the mixin, require 'ecraft/extensions/mixins/hashable'"
+
+IRB.start

data/bin/setup

@@ -0,0 +1,11 @@
+#!/usr/bin/env sh
+
+echo "<$0> Installing prerequisites..."
+
+which bundler || gem install bundler
+bundle check || bundle install
+
+echo "<$0> Done installing prerequisites!"
+echo
+echo "Explore this library using bin/console - an IRB with lib/ in the \$LOAD_PATH and this library required."
+echo

data/ecraft-extensions.gemspec

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ecraft/extensions/version'
 
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop', '~> 0.47'
+  spec.add_development_dependency 'rubocop', '~> 0.51'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'yard'
 end

data/lib/ecraft/extensions/bigdecimal.rb

@@ -23,7 +23,7 @@ class ::BigDecimal
   # Values without any fraction digits will use `Fixnum` form, where values with a fractional part will use `Float` form.
   #
   # @return [String]
-  def to_json(*_a)
+  def to_json(*_args)
     to_s
   end
 
@@ -31,14 +31,14 @@ class ::BigDecimal
   #
   # Values without any fraction digits will use `Fixnum` form, where values with a fractional part will use `Float` form.
   #
-  # @param s [String] The format that should be used for the conversion. If provided, the original `to_s` implementation will be
-  #   called using this parameter to provide the same semantics as the original method.
+  # @param string_format [String] The format that should be used for the conversion. If provided, the original `to_s`
+  #   implementation will be called using this parameter to provide the same semantics as the original method.
   # @return [String]
-  def to_s(s = nil)
-    if s.nil?
+  def to_s(string_format = nil)
+    if string_format.nil?
       to_s_original('F').gsub(/\.0$/, '')
     else
-      to_s_original(s)
+      to_s_original(string_format)
     end
   end
 end

data/lib/ecraft/extensions/mixins/hashable.rb

@@ -47,13 +47,13 @@ module Ecraft
           end
         end
 
-        def value_type?(v)
-          v.is_a?(BigDecimal) ||
-            v.is_a?(Integer) ||
-            v.is_a?(Float) ||
-            v.is_a?(String) ||
-            v.is_a?(TrueClass) ||
-            v.is_a?(FalseClass)
+        def value_type?(value)
+          value.is_a?(BigDecimal) ||
+            value.is_a?(Integer) ||
+            value.is_a?(Float) ||
+            value.is_a?(String) ||
+            value.is_a?(TrueClass) ||
+            value.is_a?(FalseClass)
         end
 
         def strip_string_recurse_enumerable_values(hash)

data/lib/ecraft/extensions/ostruct.rb

@@ -1,7 +1,7 @@
 require 'ostruct'
 
 class ::OpenStruct
-  def to_json(*_a)
+  def to_json(*_args)
     marshal_dump.to_json
   end
 end

data/lib/ecraft/extensions/string.rb

@@ -1,21 +1,9 @@
 class ::String
   # These methods should not be used in new code
-  # Instead use https://github.com/ecraft/ecraft.uxfactory.server/blob/master/documentation/upgrading-from-facets.md
+  # Instead use the examples provided.
 
-  # require 'active_support'
-  # require 'active_support/core_ext/string/inflections'
+  # Don't use! Instead, write like this:
   #
-  # 'active_support_string'.camelize # result: "ActiveSupportString"
-  def to_camelcase
-    separators = ['_', '\s']
-    str = dup
-    separators.each do |s|
-      str = str.gsub(/(?:#{s}+)([a-z])/) { Regexp.last_match(1).upcase }
-    end
-    str = str.gsub(/(\A|\s)([a-z])/) { Regexp.last_match(1) + Regexp.last_match(2).upcase }
-    str
-  end
-
   # require 'active_support'
   # require 'active_support/core_ext/string/inflections'
   #
@@ -24,20 +12,6 @@ class ::String
     gsub(/\B[A-Z]/, '_\&').downcase
   end
 
-  # require 'active_support'
-  # require 'active_support/core_ext/string/inflections'
-  # 'Foo::Bar'.constantize # => Foo::Bar
-  def to_class
-    chain = split '::'
-    klass = Kernel
-    chain.each do |klass_string|
-      klass = klass.const_get klass_string
-    end
-    klass.is_a?(Class) ? klass : nil
-  rescue NameError
-    nil
-  end
-
   def to_bool
     !self !~ /^(true|t|yes|y|1)$/i
   end

data/lib/ecraft/extensions/time.rb

@@ -1,12 +1,13 @@
 require 'json'
 require 'json/add/core'
+require 'time'
 
 class ::Time
   def as_ms
     to_i * 1000 + usec / 1000
   end
 
-  def to_json(*_a)
+  def to_json(*_args)
     # Use the precision provided in our receiver, but only up to milliseconds at max. Objects lacking the fraction part
     # altogether will be serialized without fraction part using this algorithm.
     fraction_digits = [nsec.to_s.sub(/0+$/, '').length, 3].min

data/lib/ecraft/extensions/version.rb

@@ -1,5 +1,5 @@
 module Ecraft
   module Extensions
-    VERSION = '0.3.1'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecraft-extensions
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Tre Kronor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2018-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.51'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.51'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -168,9 +168,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - ecraft-extensions.gemspec
 - lib/ecraft/extensions.rb
-- lib/ecraft/extensions/all.rb
 - lib/ecraft/extensions/bigdecimal.rb
 - lib/ecraft/extensions/date.rb
 - lib/ecraft/extensions/datetime.rb
@@ -200,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: eCraft Extensions

data/lib/ecraft/extensions/all.rb

@@ -1,7 +0,0 @@
-# Requiring this file will activate _all_ the "core extensions" defined in ecraft-extensions. This may or may not be what you want.
-# It is usually a better, safer approach to selectively require only the parts you know that you need, since core extensions _can_
-# potentially cause conflicts with other libraries extending core classes (such as ActiveSupport).
-require 'ecraft/extensions/bigdecimal'
-require 'ecraft/extensions/date'
-require 'ecraft/extensions/datetime'
-require 'ecraft/extensions/ostruct'