nicefn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0ff36475e312f9c4f1350f373aa12776882903c5e5fe4dd24966a94f1fe4d11
+  data.tar.gz: 1772fbde10fa53f54e4cf9efcf2a9f90f66fa704abc8d43acac82c1cadde314a
+SHA512:
+  metadata.gz: c53b68a7efb922503b48e43ded843a1994e4dc8fbc728d7c41ebefb195bdc0448f0c3c0217c80760f8312d7709827f4962134663ec393e4d0fce3ca661cf99b6
+  data.tar.gz: 59fffb76daf69a3ea5e981cbb45970c2e98361fa2222374c3759378b099942d5b2f253645449905cb360e68e6ae2cdd6cfed0e9064afe37fc4cb0f5b7a1951a0

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 2.5.1
+
+before_install: gem install bundler -v 1.16.5
+
+script: make

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

data/Gemfile.lock

@@ -0,0 +1,11 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+
+BUNDLED WITH
+   1.16.5

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/Makefile

@@ -0,0 +1,35 @@
+.PHONY: test
+
+default: test_all
+
+test_example_before_instance:
+	@./bin/test before inst
+
+test_example_after_instance:
+	@./bin/test after inst
+
+test_example_before_singleton:
+	@./bin/test before sing
+
+test_example_after_singleton:
+	@./bin/test after sing
+
+add_gem:
+	@cp pkg/Gemfile ./
+	@cp pkg/*.gemspec ./
+
+rem_gem:
+	@rm Gemfile && rm nicefn.gemspec
+
+test_example_project:
+	@make add_gem
+	@cd pkg/example_project && bundle install && bundle exec ruby test.rb
+	@rm pkg/example_project/Gemfile.lock
+	@make rem_gem
+
+test_all:
+	@make test_example_before_instance
+	@make test_example_after_instance
+	@make test_example_before_singleton
+	@make test_example_after_singleton
+	@make test_example_project

data/README.md

@@ -0,0 +1,101 @@
+## Ruby Nicefn
+Elixir and javascript have the capability of making good looking one liners, but
+what about Ruby? We can definitely make an awful looking one by adding a ';'. If
+you want to start defining some better looking one-liners then add the 'nicefn'
+gem to your project. Since the implementation files are small and this project
+has no required deps. You should also feel free to copy and paste the
+implementation directly into your project in an effort to avoid extra gems.
+
+## Project Structure
+Running `make` will default to running the tests inside `tst` folder against the
+examples inside the `exa` folder.
+
+## How To Use
+Add 'extend NiceFn::Inst' to the top of classes. You can also use 'include
+NiceFn::Sing' in a `module` to make it a singleton class with `nicefn` methods.
+
+### Example (Regular Classes)
+Provided below is an example class with `public`, `private`, and `protected` methods:
+```rb
+class Inst
+  attr_writer :person
+
+  def test_priv(greet)
+    priv "#{greet}"
+  end
+
+  def test_share(greet, inst)
+    inst.share greet
+  end
+
+private
+  def priv(greet)
+    puts "#{greet} #{@person}"
+  end
+
+protected
+  def share(greet)
+    puts "#{greet} #{@person}"
+  end
+end
+```
+If we use `nicefn` on this class we can eliminate 10 lines of code inside of the
+class definition. This is because `private` and `protected` are handled by
+different functions (like `defp` in `elixir`).
+
+### After Adding InstFn
+```rb
+require 'nicefn'
+
+class Inst
+  extend NiceFn::Inst
+  attr_writer :person
+
+  fn(:test_priv)  {|greet| priv "#{greet}"}
+  fn(:test_share) {|greet, inst| inst.share greet}
+
+  fp(:priv)  {|greet| puts "#{greet} #{@person}"}
+
+  fs(:share) {|greet| puts "#{greet} #{@person}"}
+end
+```
+Calling `fn` with a function `name` and a block will give you a public method.
+If you call 'fp' you will get a private method, and 'fs' will set a protected
+(shared) method.
+
+### Example (Singleton Classes)
+Provided below is an example of a singleton class that is made a singleton class
+by using extend self. 
+```rb
+module Sing
+  extend self
+  attr_writer :person
+
+  def test_priv(greet)
+    priv "#{greet}"
+  end
+
+private
+  def priv(greet)
+    puts "#{greet} #{@person}"
+  end
+end
+```
+After we add 'include NiceFn::Sing' to the module we can eliminate the need to
+extend self as 'Sing' will do it for us.
+
+### After Adding SingFn
+```rb
+require 'nicefn'
+
+module Sing
+  include NiceFn::Sing
+  attr_writer :person
+
+  fn(:test_priv) {|greet| priv greet}
+  fp(:priv)      {|greet| puts "#{greet} #{@person}"}
+end
+```
+Calling `fn` with a function `name` and a block will give you a public method.
+If you call 'fp' you will get a private method. Since singletons classes can
+only act as one instance 'fs' is not a provided option.

data/bin/test

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+# Capture stdout
+$stdout = StringIO.new
+
+# Enable test running
+require 'test/unit'
+
+# Set the name of the object type under test
+object_type_under_test = ARGV[1] == "inst" ? "Instance" : "Singleton"
+
+# Set the name of the example under test
+example_under_test = ARGV[0] == "before" ? "Before" : "After"
+
+# Define blue color code
+blue_start, blue_end = "\e[36m", "\e[0m"
+
+# Test running message
+test_message = "Testing #{object_type_under_test}, #{example_under_test} Example"
+
+# Display what test(s) we are currently running
+STDOUT.puts "------------------------------------------------------------\n" 
+STDOUT.puts "#{blue_start} #{test_message} #{blue_end}"
+STDOUT.puts "------------------------------------------------------------\n" 
+
+# Require file under test from argument
+require_relative "../exa/#{ARGV[0]}/#{ARGV[1]}.rb"
+
+# Require tests for the example under test
+require_relative "../tst/#{ARGV[1]}.rb"

data/exa/after/inst.rb

@@ -0,0 +1,13 @@
+require_relative '../../lib/nicefn.rb'
+
+class Inst
+  extend Nicefn::Inst
+  attr_writer :person
+
+  fn(:test_priv)  {|greet| priv "#{greet}"}
+  fn(:test_share) {|greet, inst| inst.share greet}
+
+  fp(:priv)       {|greet| puts "#{greet} #{@person}"}
+
+  fs(:share)      {|greet| puts "#{greet} #{@person}"}
+end

data/exa/after/sing.rb

@@ -0,0 +1,9 @@
+require_relative '../../lib/nicefn.rb'
+
+module Sing
+  include Nicefn::Sing
+  attr_writer :person
+
+  fn(:test_priv) {|greet| priv greet}
+  fp(:priv)      {|greet| puts "#{greet} #{@person}"}
+end

data/exa/before/inst.rb

@@ -0,0 +1,21 @@
+class Inst
+  attr_writer :person
+
+  def test_priv(greet)
+    priv "#{greet}"
+  end
+
+  def test_share(greet, inst)
+    inst.share greet
+  end
+
+private
+  def priv(greet)
+    puts "#{greet} #{@person}"
+  end
+
+protected
+  def share(greet)
+    puts "#{greet} #{@person}"
+  end
+end

data/exa/before/sing.rb

@@ -0,0 +1,13 @@
+module Sing
+  extend self
+  attr_writer :person
+
+  def test_priv(greet)
+    priv "#{greet}"
+  end
+
+private
+  def priv(greet)
+    puts "#{greet} #{@person}"
+  end
+end

data/lib/inst.rb

@@ -0,0 +1,5 @@
+module Nicefn::Inst
+  define_method(:fn) {|func, &blk| define_method(func, &blk) }
+  define_method(:fp) {|func, &blk| define_method(func, &blk); private func }
+  define_method(:fs) {|func, &blk| define_method(func, &blk); protected func }
+end

data/lib/nicefn.rb

@@ -0,0 +1,5 @@
+module Nicefn
+end
+
+require_relative './inst.rb'
+require_relative './sing.rb'

data/lib/sing.rb

@@ -0,0 +1,8 @@
+module Nicefn::Sing
+  extend self
+  define_method(:included) {|klass|
+    klass.extend klass
+    define_method(:fn) {|func, &blk| define_method(func, &blk) }
+    define_method(:fp) {|func, &blk| define_method(func, &blk); private func }
+  }
+end

data/nicefn.gemspec

@@ -0,0 +1,38 @@
+dir = File.dirname(File.realpath(__FILE__))
+lib = File.join(dir, 'lib')
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'nicefn'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nicefn'
+  spec.version       = "0.1.0"
+  spec.authors       = ['afaur']
+  spec.email         = ['zazu-app@googlegroups.com']
+
+  spec.summary       = %q{This gem adds an alternative way of specifying one-liners in your project.}
+  spec.description   = %q{Elixir and javascript have the capability of making
+good looking one liners, but what about Ruby? We can definitely make an awful
+looking one by adding a ';'. If you want to start defining some better looking
+one-liners then add the 'nicefn' gem to your project. Since the implementation
+files are small and this project has no required deps. You should also feel free
+to copy and paste the implementation directly into your project in an effort to
+avoid extra gems.}
+
+  spec.homepage      = 'https://github.com/afaur/ruby-nicefn.git'
+  spec.license       = 'Unlicense'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(dir) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(tst)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/pkg/example_project/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem "nicefn", :path => "../../.."

data/pkg/example_project/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: ../../..
+  specs:
+    nicefn (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nicefn!
+
+BUNDLED WITH
+   1.16.5

data/pkg/example_project/test.rb

@@ -0,0 +1,16 @@
+require 'nicefn'
+
+class Inst
+  extend Nicefn::Inst
+  fn(:test) {puts "hello from class instance"}
+end
+
+i = Inst.new
+i.test
+
+module Sing
+  include Nicefn::Sing
+  fn(:test) {puts "hello from singleton class"}
+end
+
+Sing.test

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: nicefn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- afaur
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  Elixir and javascript have the capability of making
+  good looking one liners, but what about Ruby? We can definitely make an awful
+  looking one by adding a ';'. If you want to start defining some better looking
+  one-liners then add the 'nicefn' gem to your project. Since the implementation
+  files are small and this project has no required deps. You should also feel free
+  to copy and paste the implementation directly into your project in an effort to
+  avoid extra gems.
+email:
+- zazu-app@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- README.md
+- bin/test
+- exa/after/inst.rb
+- exa/after/sing.rb
+- exa/before/inst.rb
+- exa/before/sing.rb
+- lib/inst.rb
+- lib/nicefn.rb
+- lib/sing.rb
+- nicefn.gemspec
+- pkg/example_project/Gemfile
+- pkg/example_project/Gemfile.lock
+- pkg/example_project/test.rb
+homepage: https://github.com/afaur/ruby-nicefn.git
+licenses:
+- Unlicense
+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.7.7
+signing_key: 
+specification_version: 4
+summary: This gem adds an alternative way of specifying one-liners in your project.
+test_files: []