Project

before_filters

0.0
No commit activity in last 3 years
No release in over 3 years
before_filtersidme/before_filtersHomepageDocumentationSource CodeBug TrackerWiki
An implementation of ActiveRecord before_filters in lightweight way for pure Ruby
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Popularity
Downloads
77,620
Stars
7
Forks
1
Watchers
73
 Releases
Current version
0.0.1
Total releases
1
First release
2014-01-17
Latest release
2014-01-17
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-12-04
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.3
rake
>= 0
rspec
>= 0
 Project Readme

BeforeFilters

BeforeFilters is inspired both by ActiveRecord's use of callbacks as well as the following gist: https://gist.github.com/ryanlecompte/1283413 written by Ryan LeCompte. His gist was used as the basis, but it was extended to allow an array of methods to be passed in as a list for the before_filter method to precursor.

The main use of this gem is for projects that do not include ActiveRecord, such as a Sinatra app, other gems, or internal ruby scripts.

Installation

Add this line to your application's Gemfile:

gem 'before_filters'

And then execute:

$ bundle

Or install it yourself as:

$ gem install before_filters

Usage

After installing the gem, add it as a require to the ruby script you want to use it in.

my_class.rb

require "before_filters"
class MyClass
  extend BeforeFilters
      
  attr_accessor :first_name
  attr_accessor :last_name
      
  # first arg is method to be called, second is array of methods that will have the before_filter ran
  # prior to calling the first arg
      
  before_filter :set_first_name, :only => [:set_last_name]
      
  def name
    "#{self.first_name} #{self.last_name}"
  end
      
  def set_last_name(last_name = nil)
    puts "original method"
    self.last_name = last_name
  end
      
  def set_first_name
    puts "called during before_filter"
    self.first_name = "First"
  end
end

Output shown from a pry session.

$ pry
[1] pry(main)> require "before_filters"
=> true
[2] pry(main)> class TestClass
[2] pry(main)*
[2] pry(main)*   extend BeforeFilters
[2] pry(main)*
[2] pry(main)*   attr_accessor :first_name
[2] pry(main)*   attr_accessor :last_name
[2] pry(main)*
[2] pry(main)*   # first arg is method to be called, second is array of methods that will have the before_filter ran
[2] pry(main)*   # prior to calling the first arg
[2] pry(main)*   before_filter :set_first_name, :only => [:set_last_name]
[2] pry(main)*
[2] pry(main)*   def name
[2] pry(main)*     "#{self.first_name} #{self.last_name}"
[2] pry(main)*   end
[2] pry(main)*
[2] pry(main)*   def set_last_name(last_name = nil)
[2] pry(main)*     puts "original method"
[2] pry(main)*     self.last_name = last_name
[2] pry(main)*   end
[2] pry(main)*
[2] pry(main)*   def set_first_name
[2] pry(main)*     puts "called during before_filter"
[2] pry(main)*     self.first_name = "First"
[2] pry(main)*   end
[2] pry(main)*
[2] pry(main)* end
=> :set_first_name
[3] pry(main)> test = TestClass.new
=> #<TestClass:0x0000010189d968>
[4] pry(main)> test.set_last_name("Last")
called during before_filter
original method
=> "Last"
[5] pry(main)> test.name        
=> "First Last"

TODO:

  • add support for :except => on before_filters

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request