ruby-lambdas 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bca2634a3d9d56135930a816cdc3b4abe043be6130405153c486ab143c2cab55
-  data.tar.gz: 5443e9adbcc213df2b17ddf24569829d3835b93a3bfde038484521d6df0cc4f0
+  metadata.gz: 19c424e1936c0b793d84a5401fe16e61ef506c0ce6b8973095bfe69877078748
+  data.tar.gz: 238ecf3f90787dd2094ed1c07018755f3f7b5c0f6ead52eac76d7d344a790441
 SHA512:
-  metadata.gz: e00af2a28ac449e76aa1c3b6ee4b54784d29b80b403b4e7662f707cb23ccbcdb7ad4ede7d37fec04eac197a61fe8997bad97daf947fa0926f6cc6d977bac6299
-  data.tar.gz: 45836173efbc31995aba5ec32042653b87ffb6008e99a1a5feffc118d5e1cfeb1d7230fa4dbf385262ba26916f4c0669416e16ca9de4071a1ce5e486c284e1a8
+  metadata.gz: 62eb3e3f36731b625d4629b24b6d6bed9b76643f8c6ae5e3ea8f3eb194a7b51e6170c062430bd82c4dda21fdcd404a49b0008238371a5239bdd0002c90c001f5
+  data.tar.gz: baf613b0646136602049d21c32de3bac40eb69893d015f9609c17f26b053fc6af67266eb65f8aede2565366fd88b7cd147a54885eb2c6ef7180987b6c5f0cc1d

data/README.md

@@ -9,7 +9,7 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ruby-lambdas'
+gem 'ruby-lambdas', '~> 0.1.0', require: 'ruby/lambdas'
 ```
 
 And then execute:
@@ -22,7 +22,39 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+**Basics:**
+```ruby
+require "ruby/lambdas"
+
+Strings::Strip.call(" hello ") # => "hello"
+
+# Strings::Trim is an alias to the Strings::Strip function
+Strings::Trim.call(" hello ") # => "hello"
+```
+
+**Composing functions (`RUBY_VERSION >= '2.6.0'`):**
+```ruby
+require "ruby/lambdas"
+                                # -- Alternative syntax --
+Slugify =                       # Slugify =
+  Strings::FromObject           #   Strings::String
+    .>> Strings::Strip          #     >> Strings::Trim      \
+    .>> Strings::LowerCase      #     >> Strings::LowerCase \
+    .>> Strings::GSub[' ', '-'] #     >> Strings::ReplaceAll[' ', '-']
+
+# Reading the previous composition (Step by step)
+# 1. Convert a given object (first input) as a String
+# 2. Remove all whitespaces from both sides of a string.
+# 3. Convert a string to all lower case.
+# 4. Replace all occurrences of " " by "-".
+
+# Usage
+
+Slugify.(nil)                        # => ""
+Slugify.(1)                          # => "1"
+Slugify.(1.0)                        # => "1.0"
+Slugify.(' I WILL be a url slug   ') # => "i-will-be-a-url-slug"
+```
 
 ## Development
 

data/lib/ruby/lambdas/strings.rb

@@ -4,7 +4,6 @@ module Strings
   RubyLambdas::Strings::ToExport.tap do |to_export|
     to_export
       .constants
-      .reject { |const| const == :ALIASES }
       .each do |function_name|
         function = to_export.const_get(function_name)
 

data/lib/ruby/lambdas/strings/to_export.rb

@@ -9,6 +9,8 @@ module RubyLambdas
 
       Downcase = -> data { data.downcase }
 
+      FromObject = -> data { String(data) }
+
       GSub = -> (pattern, replacement, data) do
         return data.gsub(pattern, &replacement) if replacement.is_a?(::Proc)
 
@@ -19,8 +21,9 @@ module RubyLambdas
     end
 
     ALIASES = {
-      GSub: :ReplaceAll,
       Downcase: :LowerCase,
+      FromObject: :String,
+      GSub: :ReplaceAll,
       Strip: :Trim,
     }.freeze
   end

data/lib/ruby/lambdas/version.rb

@@ -1,3 +1,3 @@
 module RubyLambdas
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lambdas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rodrigo Serradura