memo-it 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bea7d71598fcf7e38e6220c490102788ab18676
+  data.tar.gz: 90671f2691e64c594c8015ec78d030838893039e
+SHA512:
+  metadata.gz: 907eccca4b32ecac2601570837ab5055cc4da901c91023b224e9986d84a3167b0f94dc23b6738f5557566011c988977c4863cbfd4b4a3cade8dd56e3321e5c0c
+  data.tar.gz: e25aa0ae1dc7425d3881ffb9ff8fa4f46a6749598d18991d8b4b1b2f7d1070d3f66324515f81e0e77ed021872373cbfdc71ccdd331d93c045e9f0292547306b2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at phoetmail@googlemail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in memo-it.gemspec
+gemspec
+
+gem 'byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 phoet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,67 @@
+# Memo::It
+
+Clever memoization helper that uses Ruby internals instead of meta-programming.
+
+## Usage
+
+Requiring the gem will add a `memo` method to the `Object` class so that you can just use it like so:
+
+```ruby
+  def load_stuff_from_the_web
+    memo do
+      # some expensive operation like HTTP request
+      # the return value of the block will be memoized
+      HTTPClient.get('https://github.com/phoet/memo-it')
+    end
+  end
+```
+
+In case you want to memoize something that has parameters, memo-it will just use all local variables in scope to determine the memoization:
+
+```ruby
+  def load_repo(name =  'memo-it')
+    memo do
+      # in this case the result will be memoized per name
+      HTTPClient.get("https://github.com/phoet/#{name}")
+    end
+  end
+```
+
+## Installation
+
+### As a Gem
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'memo-it'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memo-it
+
+### Copy & Paste
+
+If you don't want to include yet another Gem, just run this in your shell:
+
+    $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/phoet/memo-it/master/bin/install)"
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/memo-it. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "memo/it"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/install

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'net/http'
+
+if File.read('Gemfile').match(/rails/)
+  path = 'app/lib'
+else
+  path = 'lib'
+end
+
+puts "will copy memo-it to your source,"
+puts "per default it will be copied to #{path}"
+puts "if you want a different location,"
+puts "just enter it now, otherwise just hit RETURN"
+print "$ "
+input = gets.chomp
+
+path = input unless input.empty?
+
+FileUtils.mkdir_p(path)
+response = Net::HTTP.get(URI("https://raw.githubusercontent.com/phoet/memo-it/master/lib/memo/it.rb"))
+File.write(File.join(path, 'memo-it.rb'), response)
+
+puts "<3 happy memoization!"

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/memo/it.rb

@@ -0,0 +1,15 @@
+module Memo
+  VERSION = '0.1.0'
+  module It
+    def memo(&block)
+      keys = block.source_location
+      keys << block.binding.local_variables.map { |name| [name, block.binding.local_variable_get(name).to_s] }
+
+      @_memo_it ||= {}
+      @_memo_it[keys] if @_memo_it.key? keys
+      @_memo_it[keys] = yield
+    end
+  end
+end
+
+Object.include Memo::It

data/memo-it.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memo/it'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memo-it"
+  spec.version       = Memo::VERSION
+  spec.authors       = ["phoet"]
+  spec.email         = ["phoetmail@googlemail.com"]
+
+  spec.summary       = %q{📥 📤 simple yet clever memoization helper with parameter support}
+  spec.description   = File.read('README.md')
+  spec.homepage      = "https://github.com/phoet/memo-it"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: memo-it
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- phoet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |
+  # Memo::It
+
+  Clever memoization helper that uses Ruby internals instead of meta-programming.
+
+  ## Usage
+
+  Requiring the gem will add a `memo` method to the `Object` class so that you can just use it like so:
+
+  ```ruby
+    def load_stuff_from_the_web
+      memo do
+        # some expensive operation like HTTP request
+        # the return value of the block will be memoized
+        HTTPClient.get('https://github.com/phoet/memo-it')
+      end
+    end
+  ```
+
+  In case you want to memoize something that has parameters, memo-it will just use all local variables in scope to determine the memoization:
+
+  ```ruby
+    def load_repo(name =  'memo-it')
+      memo do
+        # in this case the result will be memoized per name
+        HTTPClient.get("https://github.com/phoet/#{name}")
+      end
+    end
+  ```
+
+  ## Installation
+
+  ### As a Gem
+
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'memo-it'
+  ```
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install memo-it
+
+  ### Copy & Paste
+
+  If you don't want to include yet another Gem, just run this in your shell:
+
+      $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/phoet/memo-it/master/bin/install)"
+
+  ## Development
+
+  After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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).
+
+  ## Contributing
+
+  Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/memo-it. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+  ## License
+
+  The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+email:
+- phoetmail@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/install
+- bin/setup
+- lib/memo/it.rb
+- memo-it.gemspec
+homepage: https://github.com/phoet/memo-it
+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.8
+signing_key: 
+specification_version: 4
+summary: "\U0001F4E5 \U0001F4E4 simple yet clever memoization helper with parameter
+  support"
+test_files: []