stateless_module 1.0.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abd6e41c388e3cc924ed948ca61ddc8efe92ceeb
-  data.tar.gz: 437c82acdf440a4e59a35cdf843f1497417fed15
+  metadata.gz: 19f88067a73deb2fcf6d9087645c141813ef4277
+  data.tar.gz: 09c762c85169ba9cb7e6a7d6208c97125f1e9de4
 SHA512:
-  metadata.gz: 08009f97eb82a37dec5f476bd1d0b693fd25032bf399d311485f2b137963dbe246e460710e6932161c77b4be3c4ed558763bd912076b9221d5bcd6f060cf6aec
-  data.tar.gz: b9b114bed096d37d26e3a909ab10f4d6930a5309661695e8f277dc3c301b2fb9220d27ebe9e5841e3c9be807491a701907d869a1f039cfb84431df0bb2c63c7c
+  metadata.gz: c9d324e727b4cde1ab7c2b05f11203a72ac7768cd47c1537de8341979a84c00f37366ec4f2df6848db60ba5e079f368d6bd6147a8062efba3aac8589d728f870
+  data.tar.gz: 3f7d3148ebcc62487e77a000a4349a77605f12fa5bbd2f5d4834cd3decc447ac987ee3481a8495930c854942a5ec5a57cc117790ddf73f491a6c37a695d3f02b

data/README.md

@@ -1,61 +1,54 @@
 # StatelessModule
 
-A simple lib that wraps `extend self` in Ruby modules.
+A dead simple little library to help create stateless / immutable modules in Ruby.
 
-## Installation
+Once you declare that your module is stateless, then it will be protected from being included or extended
+elsewhere and all of its instance and class variables will be protected from mutation.
 
-`gem install stateless_module'
+Ruby is a great object oriented language, but sometimes you want to carve out a small island of sanity where you have no state to keep track of
+and where you can be guaranteed that your code won't be used out of context (e.g threading).
 
-## Examples
+You can read about some of the benefits to this approach <a href="http://stackoverflow.com/questions/844536/advantages-of-stateless-programming" target="_blank">here</a>.
 
-```ruby
-module YourModule
-  stateless_module
+## Derp
 
-  def some_method
-    42
-  end
+> This is stupid. I could just use `module_function`, or `extend self`, or a frozen singleton, or a frozen module, or _blank_ to do the same thing...
 
-  def complex_method
-    some_private_method
-  end
+Maybe. But all of those approaches lack something: `module_function` falls down with private methods; `extend self` offers zero protection against mutation
+(or being included elsewhere); a frozen singleton would be pretty close, but you'd still be able to mutate instance variables and, semantically,
+a singleton is an _instance_ of a thing, which is what we're trying to get away from here.
 
-  private
+A frozen module would be very close, indeed, to what this library offers, but you'd still have no protection against any instance variables themselves
+being mutated.
 
-  def some_private_method
-    7
-  end
-end
-```
+At the end of the day, you could write all of this code in under an hour.
 
-You could then use `YourModule` as a semi-stateless module /  namespace:
+Or you could just save yourself the hassle and use this gem.
 
-```ruby
-YourModule.some_method
-# => 42
 
-YourModule.complex_method
-# => 7
+## Installation
 
-class SomeClass
-  include YourModule
-end
-# => Error
-```
+`gem install stateless_module'
 
-## Why not just use `module_function` ?
+stateless_module makes use of <a href="http://ruby-doc.org/core-2.0.0/TracePoint.html" target="_blank">TracePoint</a> so it's only good for Ruby 2.0+
 
-You could. But `module_function` has some problems with private methods.
-It's not really an exact replacement of `extend self`.
+## Usage
 
-## OK. Why not just use `extend self` ?
+Simply call the `stateless` function from within your module:
+
+```ruby
+module MyModule
+  stateless_module
 
-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.
+  def some_function
+    # ...
+  end
 
-This adds a bit of safety by enforcing that your module won't get mixed up
-in some other class / modules state.
+  def another_function
+    # ...
+  end
 
-Also declaring `stateless_module` is a bit more descriptive than
-`extend self`.
+  # etc...
+end
+```
 

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bundler', 'bundler')

data/bin/pry

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('pry', 'pry')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/stateless_module.rb

@@ -1,10 +1,10 @@
-require "stateless_module/module"
-
 module StatelessModule
   class << self
     def included(base)
       base.send(:extend, base)
 
+      freeze_when_module_completes(base)
+
       base.class_eval do
         class << self
           def included(base)
@@ -30,5 +30,35 @@ module StatelessModule
     def extended(base)
       raise "Use Stateless Module by including it - not by extending it."
     end
+
+    #######
+    private
+    #######
+
+    def freeze_when_module_completes(base)
+      TracePoint.trace(:end) do |t|
+        if base == t.self
+          base.freeze
+
+          base.instance_variables.each do |v|
+            base.instance_variable_get(v).freeze
+          end
+
+          base.class_variables.each do |v|
+            base.class_variable_get(v).freeze
+          end
+
+          t.disable
+        end
+      end
+    end
+
   end
 end
+
+class Module
+  def stateless_module
+    include StatelessModule
+  end
+end
+

data/lib/stateless_module/version.rb

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

data/stateless_module.gemspec

@@ -9,6 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jim Whiteman"]
   spec.email         = ["jimtron9000@gmail.com"]
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stateless_module
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Jim Whiteman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-19 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,10 +79,13 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/bundler
 - bin/console
+- bin/pry
+- bin/rake
+- bin/rspec
 - 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
@@ -97,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/stateless_module/module.rb

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