refined-refinements 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5294d42af35dee68ae9f9d9477d83a39ec3d5de2
+  data.tar.gz: '056769fd009f3c71f019322a53ff7577b543a585'
+SHA512:
+  metadata.gz: d915c1737d66d960769ba4c72ddbd2022d7b326a5cf2639d46d93c87592335dd19dea33a181d012e914b28e46a4d57e9f12ea289cfb5a8b9f5842872942bc631
+  data.tar.gz: 86d9e617849bcbc70fdfe70db3630ec6eadc04c1da25ac67965e618eb7c52bac3f318dff45a39381bf58565f996256938241e0b3c44b6d6b326f953ed58d1a6c

data/README.md

@@ -0,0 +1,53 @@
+# About
+
+Collection of core class extensions I found useful across multiple projects. They are implemented as refinements, they do not override the global scope, so are safe to use.
+
+Refinements allow you to redefine methods on core classes only within given context. For instance if you have class Foo and you want to redefine String#gsub only within that class, you can do so using refinements. Magnus Holm wrote a nice [intro into refinements](http://timelessrepo.com/refinements-in-ruby).
+
+## RR::ColourExts
+
+```ruby
+require 'refined-refinements/colours'
+
+using RR::ColourExts
+
+puts '<green>Hello <red.bold>world</red.bold></green>!'.colourise
+puts '<green>Hello <red.bold>world</red.bold></green>!'.colourise(bold: true)
+```
+
+## RR::MatchingExts
+
+```ruby
+require 'refined-refinements/matching'
+
+using RR::MatchingExts
+
+string = 'Hello <bold>bold</bold> world!'
+regexp = /
+  <(?<tag_name>[^>]+)>
+  (?<inner_text>.+)
+  <\/\k<tag_name>>
+/x
+
+string.sub(regexp) do |match, text_before_match, text_after_match|
+  p [:m, match]
+  p [:b, text_before_match]
+  p [:a, text_after_match]
+end
+
+# [:m, #<MatchData "<bold>bold</bold>" tag_name:"bold" inner_text:"bold">]
+# [:b, "Hello "]
+# [:a, " world!"]
+```
+
+## RR::MatchingExts
+
+```ruby
+require 'refined-refinements/string'
+
+using RR::StringExts
+
+puts 'hello world!'.titlecase
+
+# Hello world!
+```

data/lib/refined-refinements/colours.rb

@@ -0,0 +1,50 @@
+require 'term/ansicolor'
+require 'refined-refinements/matching'
+
+module RR
+  module ColourExts
+    def self.colours
+      @colours ||= Object.new.extend(Term::ANSIColor)
+    end
+
+    refine String do
+      using RR::MatchingExts
+
+      def colourise(options = Hash.new)
+        regexp = /
+          <(?<dot_separated_methods>[^>]+)>
+            (?<text_between_tags>.*?)
+          <\/\k<dot_separated_methods>>
+        /xm
+
+        colours = RR::ColourExts.colours
+
+        result = self.gsub(regexp) do |match|
+          # p [:m, match] ####
+          methods = match[:dot_separated_methods].split('.').map(&:to_sym)
+          methods.push(:bold) if options[:bold]
+          # p [:i, match[:text_between_tags], methods, options] ####
+
+          methods.reduce(inner_text = match[:text_between_tags]) do |result, method|
+            # (print '  '; p [:r, result, method]) if result.match(/(<\/[^>]+>)/) ####
+            result.gsub!(/(<\/[^>]+>)/, "#{colours.send(method)}\\1")
+            # puts "#{result.inspect}.#{method}" ####
+            "#{colours.send(method)}#{result}#{colours.reset unless options[:recursed]}"
+          end
+        end
+
+        result.match(regexp) ? result.colourise(options.merge(recursed: true)) : result
+      end
+    end
+  end
+end
+
+# using RR::ColourExts
+#
+# s1 = "<green>Hello <red>world</red>!</green>"
+# s2 = "<green>H<yellow>e</yellow>llo <red>world</red>!</green>" # F
+# s3 = "<green>H</green>ello <red>w</red>orld!"
+#
+# puts s1.colourise, ''
+# puts s2.colourise(bold: true), ''
+# puts s3.colourise, ''

data/lib/refined-refinements/date.rb

@@ -0,0 +1,15 @@
+require 'date'
+
+module RR
+  module DateExts
+    refine Date do
+      def weekend?
+        self.saturday? || self.sunday?
+      end
+
+      def weekday?
+        ! self.weekend?
+      end
+    end
+  end
+end

data/lib/refined-refinements/matching.rb

@@ -0,0 +1,33 @@
+module RR
+  module MatchingExts
+    # Counter-intuitively when regexp replacement methods are called with a block,
+    # the first and only block argument is the whole match as a string.
+    #
+    # There is no way to get match groups and the string before and after the match
+    # other than using global variables such as $~, $1, $` etc.
+    #
+    # The problem with that, besides readability and violations of basic
+    # industry practices, is that the minute you use another String#sub or
+    # String#match, these variables gets reassigned.
+    #
+    # With this refinement you can access these variables through block arguments:
+    #
+    #   using RR::CoreExts
+    #
+    #   'Hello world!'.sub(/(?<word>[a-zA-Z]+)/) do |match, string_before_match, string_after_match|
+    #     match[:word].upcase
+    #   end
+
+    refine String do
+      [:sub, :sub!, :gsub, :gsub!].each do |method_name|
+        define_method(method_name) do |*args, &block|
+          if block
+            super(*args) { block.call($~, $`, $') }
+          else
+            super(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/refined-refinements/string.rb

@@ -0,0 +1,9 @@
+module RR
+  module StringExts
+    refine String do
+      def titlecase
+        "#{self[0].upcase}#{self[1..-1]}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: refined-refinements
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James C Russell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-27 00:00:00.000000000 Z
+dependencies: []
+description: "."
+email: james@101ideas.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/refined-refinements/colours.rb
+- lib/refined-refinements/date.rb
+- lib/refined-refinements/matching.rb
+- lib/refined-refinements/string.rb
+homepage: http://github.com/botanicus/refined-refinements
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []