No release in over 3 years
prevent automatic access to controller instance variables and enforce exposure via helper methods
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.17
~> 5.0
>= 4.2.0
~> 10.0

Runtime

>= 4.2.0
 Project Readme

ControlledExposure

explicit expose rails controller @instance variables as helpers in views. optional prevent all access to @instance variables in views.

Changes

2.0

  • add attr_expose
  • add def_expose
  • deprecate expose
  • this is now based on ActiveSupport::Concern

Installation

Add this line to your application's Gemfile:

gem 'controlled_exposure'

And then execute:

$ bundle

Or install it yourself as:

$ gem install controlled_exposure

Usage

in your controller app/controllers/hello_controller.rb

class HelloController < ApplicationController
  enforce_expose!
  attr_expose :foo, :bar

  def show
    @foo = 'Hello'
    self.bar = 'World!'
  end
end

and app/views/hello/show.html.erb

<%= foo %><%= bar %>

instead of

<%= @foo %><%= @bar %>

There is also a def_expose

class HelloController < ApplicationController
  def_expose :foobar do
    "Hello World!"
  end
end

which is a shorthand for

class HelloController < ApplicationController
  def foobar
    "Hello World!"
  end

  helper_method :foobar
  protected_method :foobar
end

Enable for All Controllers

class ApplicationController < ActionController::Base
  enforce_expose!
  attr_expose :foo
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/stepahn/controlled_exposure.

License

The gem is available as open source under the terms of the MIT License.