flirt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 564e3009a8c2864fb2de008cb57be72e8440017f
-  data.tar.gz: 87e6f2718d7ffa0d922b79f73bb718b469704a56
+  metadata.gz: 034106def78faf22575247bb9ade0a9efe6fd2fc
+  data.tar.gz: 3c8de9cf124629172f5873d8608186cfec4a03dd
 SHA512:
-  metadata.gz: b97a5309761523a1e376c56333ebaaf4d9a8315d21774fd84b8b66bd37ffcdfe0d1e801bd9e37b7c9bf40f7feaeb821a46b5e90c22684574f2324677c2fdaa04
-  data.tar.gz: 19ffd5697790350cdab302e69aaaf39437589d17c0f6fcec617c1e22708a97a342ca3c3c1eb745c04f0bbdf44fe7a8f7b2b763f05b4b2784445a54d27dfef2f9
+  metadata.gz: 0d283374e38b19974d41218ac869a303d574144b32e2dcc3ec07466cb557e2c63856cc8c598096fca966a744cb00a077962836a1f2488ed399f5e6e1f95781bc
+  data.tar.gz: 90d7fe9305f4b7caea95d077a9be45b6141a10162e4ee3f75cb45bc38a0166ecc53629d16ff51e942e23b27b497da2e35297ae0663bc460113b0e713fc1fadcb

data/README.md

@@ -55,7 +55,6 @@ end
 
 ```ruby
     Flirt.unsubscribe self, :picked, with: :picked_callback
-end
 ```
 
 
@@ -149,6 +148,73 @@ Flirt.clear
 
 This operation cannot be undone.
 
+##Motivation
+
+Ruby projects (and Rails projects in particular) can easily become a mess of tightly coupled code. The Rails framework almost encourages the idea of 'fat models', with features like callbacks (often touching other models and thus coupling themselves) and concerns (that use modules to hide code that often should really have its own class) to name but two.
+
+The observer (or pub/sub) pattern can help decouple code, decompose large classes and allow for smaller classes with a single purpose. This promotes easy testing, readability, maintainability and eventually stability of your code.
+
+So why another gem, considering there are already several gems and a Ruby language feature that implement this pattern?
+
+### Flirt is tiny
+
+Flirt gives you just enough to use and test the pub/sub pattern with the minimum of cruft. The number of objects is kept to a minimum for speed and ease of debugging. The extendable Listener module has only the two methods you need to use.
+
+### Flirt use is obvious and readable
+
+With such a simple syntax, it's easy to understand what Flirt is doing when you revisit your code again in three months.
+
+### Flirt is opinionated
+
+There is no set-up beyond requiring the gem.
+
+Events are only allowed to be represented as symbols. Using strings or other objects will result in an exception, helping to spot and squash certain kinds of bugs early.
+
+Only one object - Flirt - can be listened to, reducing the danger of implicit coupling between publishers and subscribers. Subscribers listen to events, not objects.
+
+### Flirt has a great name
+
+Seriously, why use any other gem when you could be flirting instead?
+
+##Testing
+
+In order to test units of behaviour, you probably want to disable Flirt and test each unit of your code in isolation. You can always enable Flirt or individual events in your test file for integration tests.
+
+You'll want to clear Flirt before each test as well, to stop callbacks building up.
+
+If you're using RSpec, you probably want to disable and clear Flirt in the before block in ```spec/spec_helper.rb```:
+
+```ruby
+
+RSpec.configure do |config|
+
+  config.before(:each) do
+    Flirt.disable
+    Flirt.clear
+  end
+  ...
+```
+
+If you're using MiniTest, something like this might help:
+
+
+```ruby
+module FlirtMinitestPlugin
+  def before_setup
+    super
+    Flirt.disable
+    Flirt.clear
+  end
+end
+
+class MiniTest::Unit::TestCase
+  include FlirtMinitestPlugin
+end
+```
+
+Another gem will probably appear soon to wrap common testing patterns around the use of Flirt. Watch this space.
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/flirt/fork )

data/flirt.gemspec

@@ -4,22 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'flirt/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "flirt"
-  spec.version       = Flirt::VERSION
-  spec.authors       = ["Benjamin Randles-Dunkley"]
-  spec.email         = ["ben@chemica.co.uk"]
-  spec.summary       = %q{ A brutally simple take on the observer pattern. }
-  spec.description   = %q{ Provides a single point for the publication and subscription of events, promoting extreme decoupling. }
-  spec.homepage      = "https://github.com/chemica/flirt"
-  spec.license       = "MIT"
+  spec.name                  = "flirt"
+  spec.version               = Flirt::VERSION
+  spec.authors               = ["Benjamin Randles-Dunkley"]
+  spec.email                 = ["ben@chemica.co.uk"]
+  spec.summary               = %q{ A brutally simple take on the observer pattern. }
+  spec.description           = %q{ Provides a single point for the publication and subscription
+                                   of events, promoting extreme decoupling. }
+  spec.homepage              = "https://github.com/chemica/flirt"
+  spec.license               = "MIT"
+  spec.required_ruby_version = '>= 1.9.2'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.files                 = `git ls-files -z`.split("\x0")
+  spec.executables           = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files            = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths         = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "byebug", "~> 4.0"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.2"
+#  spec.add_development_dependency "byebug", "~> 4.0"
 end

data/lib/flirt/version.rb

@@ -1,5 +1,5 @@
 module Flirt
 
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 
 end

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ require 'rubygems'
 require 'bundler/setup'
 Bundler.setup
 
-require 'byebug'
+#require 'byebug'
 require 'flirt'
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flirt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Benjamin Randles-Dunkley
@@ -52,22 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-description: " Provides a single point for the publication and subscription of events,
-  promoting extreme decoupling. "
+description: " Provides a single point for the publication and subscription\n                                   of
+  events, promoting extreme decoupling. "
 email:
 - ben@chemica.co.uk
 executables: []
@@ -101,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -109,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: A brutally simple take on the observer pattern.