tiny_sweeper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b3312c9ca196aa0ccc80e866b5c972df40a55c7
+  data.tar.gz: 3f784d995ee4dbbda4555888bfb239581602a31d
+SHA512:
+  metadata.gz: 308e7c5b89350405f4ca03af67c8468f51a444aa3c96a4e9a9b4e6bede4ed70764b8ea07f0bd951dcfc11d125c6fffaf0e05d451cf080cff6abae7a6376b4ac7
+  data.tar.gz: 804648e58f8c3b0d7a3cfaf8d186ada84033c13e026b0daf326b5660063237ceda8304111293af406f3870a3204f033487bac46c4b5160aac04ac7e1e97364b4

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+tiny_sweeper

data/.ruby-version

@@ -0,0 +1 @@
+ruby 2.2.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0
+  - 1.9

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec

data/README.md

@@ -0,0 +1,105 @@
+# TinySweeper
+
+TinySweeper keeps your objects tidy!
+
+It's a handy way to clean attributes on your Rails models, though it's independent of Rails, and can be used in any Ruby project. It gives you a light-weigt way to override your methods and declare how their inputs should be cleaned.
+
+[![Build Status](https://travis-ci.org/ContinuityControl/tiny_sweeper.png?branch=master)](https://travis-ci.org/ContinuityControl/tiny_sweeper)
+[![Code Climate](https://codeclimate.com/github/ContinuityControl/tiny_sweeper.png)](https://codeclimate.com/github/ContinuityControl/tiny_sweeper)
+
+## How Do I Use It?
+
+```ruby
+class Sundae
+  attr_accessor :topping
+
+  include TinySweeper
+  sweep(:topping) { |topping| topping.strip.downcase }
+end
+```
+
+Now your Sundae toppings will be tidied up:
+
+```ruby
+dessert = Sundae.new
+dessert.topping = ' ButTTERscotCH   '
+dessert.topping #=> 'butterscotch'. Tidy!
+```
+
+If you have an object with lots of attributes that need cleaning, you can do that, too:
+
+```ruby
+dessert.sweep_up!
+# or:
+Sundae.sweep_up!(dessert)
+```
+
+### Future Ideas
+
+Just spit-balling here...
+
+It'd be nice to define sweep-ups for multiple fields.
+
+If you often sweep up fields in the same way - say, squishing and nilifying blanks - it'd be nice to bundle that up in some way, so you don't have to repeat yourself. Something like this might be nice:
+
+```ruby
+# in config/initializers/tiny_sweeper.rb, or similar:
+TinySweeper.sweep_style(:squish_and_nil_blanks) { |value|
+  ...
+}
+
+class Sundae
+  sweep :topping, :squish_and_nil_blanks
+end
+```
+
+If TinySweeper doesn't know the sweeping technique you asked for, it would send it to the value in the typical symbol-to-proc fashion:
+
+```ruby
+class Sundae
+  # This:
+  sweep :topping, :strip
+  # ...would be the same as this:
+  sweep :topping { |t| t.strip }
+end
+```
+
+## How Does It Work?
+
+You include the `TinySweeper` module in your class, and define some sweep-up rules on your class' attributes. It overrides your method, and defines a new method that cleans its input according to the sweep-up rule, and then calls the original method with the clean value.
+
+"Isn't it better to generate a module for the new methods, and call `super`?"
+
+Sure, but if you do that, the module's method is called *after* the original one. We want to clean the input *before* it gets to your method.
+
+"Why not use `after_create` or `before_save` or `before_validate` callbacks?"
+
+That's one approach, and it's used by [nilify_blanks](https://github.com/rubiety/nilify_blanks), so it's clearly workable.
+
+But it means your data isn't cleaned until the callback runs; TinySweeper cleans your data as soon as it arrives.
+
+Also, it requires rails, so you can't use it outside of rails.
+
+## Install It
+
+The standard:
+
+```
+$ gem install tiny_sweeper
+```
+
+or add to your Gemfile:
+
+```
+gem 'tiny_sweeper'
+```
+
+## Contributing
+
+Help is always appreciated!
+
+* Fork the repo.
+* Make your changes in a topic branch. Don't forget your specs!
+* Send a pull request.
+
+Please don't update the .gemspec or VERSION; we'll coordinate that when we release an update.

data/lib/tiny_sweeper.rb

@@ -0,0 +1,56 @@
+module TinySweeper
+  module ClassMethods
+    def sweep(field_name, &sweeper)
+      stop_if_attribute_does_not_exist!(field_name)
+      stop_if_we_have_seen_this_before!(field_name)
+
+      writer_method_name = writer_method_name(field_name)
+
+      alias_method "original #{writer_method_name}", writer_method_name
+
+      define_method(writer_method_name) do |value|
+        clean_value = sweeper.call(value)
+        send("original #{writer_method_name}", clean_value)
+      end
+    end
+
+    def sweep_up!(instance)
+      @swept_fields.each do |field|
+        instance.send("#{field}=", instance.send(field))
+      end
+    end
+
+    private
+
+    def stop_if_attribute_does_not_exist!(field_name)
+      unless instance_methods.include?(writer_method_name(field_name))
+        raise "There is no method named #{field_name.inspect} to sweep up!"
+      end
+    end
+
+    def stop_if_we_have_seen_this_before!(field_name)
+      @swept_fields ||= []
+
+      if @swept_fields.include?(field_name)
+        raise "Don't sweep #{field_name} twice!"
+      end
+
+      @swept_fields << field_name
+    end
+
+    def writer_method_name(field_name)
+      "#{field_name}=".to_sym
+    end
+  end
+
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+  end
+
+  def sweep_up!
+    self.class.sweep_up!(self)
+  end
+end
+
+# Do it on all fields, by default? Or be explicit?
+# TODO: add EagerSweeper, which loops over attributes

data/lib/tiny_sweeper/version.rb

@@ -0,0 +1,3 @@
+module TinySweeper
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/tiny_sweeper_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'tiny_sweeper'
+
+describe 'cleaning fields' do
+  class Contract
+    attr_accessor :name, :notes
+
+    include TinySweeper
+    sweep :notes, &:strip
+    sweep(:name) { |n| n.upcase }
+  end
+
+  it 'leaves some unfortunate method names, maybe?' do
+    contract = Contract.new
+    original_writers = contract.methods.grep(/^original /).sort
+    expect(original_writers).to eq([:"original name=", :"original notes="])
+    # NB: we're not saying this is GOOD, we're just noting it.
+  end
+
+  it 'strips notes' do
+    contract = Contract.new
+    contract.notes = ' needs stripping '
+    expect(contract.notes).to eq('needs stripping')
+  end
+
+  it 'upcases name' do
+    contract = Contract.new
+    contract.name = 'gonna shout it'
+    expect(contract.name).to eq('GONNA SHOUT IT')
+  end
+
+  describe 'sweeping up ALL the fields at once' do
+    let(:the_contract) {
+      Contract.new.tap do |c|
+        c.name = '  will be upcased  '
+        c.notes = '  will be stripped  '
+      end
+    }
+
+    it 'can clean itself' do
+      the_contract.sweep_up!
+      expect(the_contract.name).to eq '  WILL BE UPCASED  '
+      expect(the_contract.notes).to eq 'will be stripped'
+    end
+
+    it 'can be cleaned from the class' do
+      Contract.sweep_up!(the_contract)
+      expect(the_contract.name).to eq '  WILL BE UPCASED  '
+      expect(the_contract.notes).to eq 'will be stripped'
+    end
+  end
+
+  it 'will bark if you try to re-define a field twice' do
+    some_class = Class.new
+    some_class.send(:include, TinySweeper)
+    some_class.send(:attr_accessor, :name)
+    some_class.send(:sweep, :name, &:strip)
+
+    # Now the class is sweeping up name, awesome!
+    # What if we try to sweep it AGAIN?
+
+    expect {
+      some_class.send(:sweep, :name, &:upcase)
+    }.to raise_error
+  end
+
+  it "will bark if you sweep a method that doesn't exist" do
+    some_class = Class.new
+    some_class.send(:include, TinySweeper)
+    expect {
+      some_class.send(:sweep, :attribute, &:whatever)
+    }.to raise_error("There is no method named :attribute to sweep up!")
+  end
+end

data/tiny_sweeper.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tiny_sweeper/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'tiny_sweeper'
+  s.version     = TinySweeper::VERSION
+  s.date        = Date.today.to_s
+
+  s.summary     = "A tiny helper to clean your inputs"
+  s.description = "
+    Tiny Sweeper is a handy way to clean attributes on your Rails models,
+    though it's independent of Rails, and can be used in any Ruby project.
+    It gives you a light-weight way to override your methods and declare
+    how their inputs should be cleaned.
+  ".strip.gsub(/^\s*/, '')
+  s.homepage    = 'https://github.com/ContinuityControl/tiny_sweeper'
+  s.license     = 'ASL2'
+
+  s.authors     = ["Dan Bernier"]
+  s.email       = ['dbernier@continuity.net']
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.5"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: tiny_sweeper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Bernier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: |-
+  Tiny Sweeper is a handy way to clean attributes on your Rails models,
+  though it's independent of Rails, and can be used in any Ruby project.
+  It gives you a light-weight way to override your methods and declare
+  how their inputs should be cleaned.
+email:
+- dbernier@continuity.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/tiny_sweeper.rb
+- lib/tiny_sweeper/version.rb
+- spec/spec_helper.rb
+- spec/tiny_sweeper_spec.rb
+- tiny_sweeper.gemspec
+homepage: https://github.com/ContinuityControl/tiny_sweeper
+licenses:
+- ASL2
+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: A tiny helper to clean your inputs
+test_files:
+- spec/spec_helper.rb
+- spec/tiny_sweeper_spec.rb