stateless_module 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abd6e41c388e3cc924ed948ca61ddc8efe92ceeb
+  data.tar.gz: 437c82acdf440a4e59a35cdf843f1497417fed15
+SHA512:
+  metadata.gz: 08009f97eb82a37dec5f476bd1d0b693fd25032bf399d311485f2b137963dbe246e460710e6932161c77b4be3c4ed558763bd912076b9221d5bcd6f060cf6aec
+  data.tar.gz: b9b114bed096d37d26e3a909ab10f4d6930a5309661695e8f277dc3c301b2fb9220d27ebe9e5841e3c9be807491a701907d869a1f039cfb84431df0bb2c63c7c

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stateless_module.gemspec
+gemspec

data/README.md

@@ -0,0 +1,61 @@
+# StatelessModule
+
+A simple lib that wraps `extend self` in Ruby modules.
+
+## Installation
+
+`gem install stateless_module'
+
+## Examples
+
+```ruby
+module YourModule
+  stateless_module
+
+  def some_method
+    42
+  end
+
+  def complex_method
+    some_private_method
+  end
+
+  private
+
+  def some_private_method
+    7
+  end
+end
+```
+
+You could then use `YourModule` as a semi-stateless module /  namespace:
+
+```ruby
+YourModule.some_method
+# => 42
+
+YourModule.complex_method
+# => 7
+
+class SomeClass
+  include YourModule
+end
+# => Error
+```
+
+## Why not just use `module_function` ?
+
+You could. But `module_function` has some problems with private methods.
+It's not really an exact replacement of `extend self`.
+
+## OK. Why not just use `extend self` ?
+
+You could - and maybe you should. But this lib also makes it so that any
+module you define as stateles won't be able to be included or extended elsewhere.
+
+This adds a bit of safety by enforcing that your module won't get mixed up
+in some other class / modules state.
+
+Also declaring `stateless_module` is a bit more descriptive than
+`extend self`.
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stateless_module"
+
+# 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/setup

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

data/lib/stateless_module.rb

@@ -0,0 +1,34 @@
+require "stateless_module/module"
+
+module StatelessModule
+  class << self
+    def included(base)
+      base.send(:extend, base)
+
+      base.class_eval do
+        class << self
+          def included(base)
+            raise_stateless_module_error
+          end
+
+          def extended(base)
+            raise_stateless_module_error
+          end
+
+          #######
+          private
+          #######
+
+          def raise_stateless_module_error
+            raise "#{self.name} is a Stateless Module. " \
+                  "Don't include it elsewhere."
+          end
+        end
+      end
+    end
+
+    def extended(base)
+      raise "Use Stateless Module by including it - not by extending it."
+    end
+  end
+end

data/lib/stateless_module/module.rb

@@ -0,0 +1,5 @@
+class Module
+  def stateless_module
+    include StatelessModule
+  end
+end

data/lib/stateless_module/version.rb

@@ -0,0 +1,3 @@
+module StatelessModule
+  VERSION = "1.0.1"
+end

data/stateless_module.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stateless_module/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stateless_module"
+  spec.version       = StatelessModule::VERSION
+  spec.authors       = ["Jim Whiteman"]
+  spec.email         = ["jimtron9000@gmail.com"]
+
+  spec.summary       = %q{Simple lib for semi-stateless modules.}
+  spec.description   = %q{A simple lib for semi-stateless modules in Ruby.}
+  spec.homepage      = "https://github.com/jwhiteman/stateless_module"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: stateless_module
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Jim Whiteman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple lib for semi-stateless modules in Ruby.
+email:
+- jimtron9000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stateless_module.rb
+- lib/stateless_module/module.rb
+- lib/stateless_module/version.rb
+- stateless_module.gemspec
+homepage: https://github.com/jwhiteman/stateless_module
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple lib for semi-stateless modules.
+test_files: []