Sha256: 9907f54bef34bac4ce61e49fd0669645e140d1b88362c573872a288cbfc82fa3

Contents?: true

Size: 1.3 KB

Versions: 1

Compression:

Stored size: 1.3 KB

Contents

# Pubdraft

Quickly add published/drafted states to your ActiveRecord models, with helpful scopes and instance methods for querying and changing the states

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'pubdraft'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install pubdraft

## Usage

```ruby
# requires string column `state` to exist
# $ rails g migration AddStateToMyModels state

class MyModel < ActiveRecord::Base
  pubdraft
end

record = MyModel.create!
record.published? #=> true

record.draft!
record.drafted?   #=> true

record.publish!
record.published? #=> true

MyModel.published #=> [published records]
MyModel.drafted   #=> [drafted records]
```

## View Helpers

The gem provides a view helper to easily populate select boxes
```erb
<!-- Standard Form Helpers -->
<%= form_for @record do |f| %>
  <%= f.select :state, pubdraft_state_options %>
<% end %>

<!-- Formtastic -->
<%= semantic_form_for @record do |f| %>
  <%= f.input :state, :collection => pubdraft_states_for_select, :as => :select %>
<% end %>
```

## 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

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
pubdraft-0.0.2 README.md