Giter Club home page Giter Club logo

is_publishable's Introduction

is_publishable

Adds publishing capabilities to a model. Supports marking a model as published/unpublished as well as publishing models in the future.

Installation

Add this line to your application's Gemfile:

gem 'is_publishable'

And then execute:

$ bundle

Or install it yourself as:

$ gem install is_publishable

Usage

To add publishing to a model, first run the generator. Let's assume the model's name is Article

$ rails generate publishable Article

This will create the following migration:

class AddPublishingToArticles < ActiveRecord::Migration
  def up
    add_column :articles, :published, :boolean, default: false
    add_column :articles, :published_at, :datetime
  end
  def down
    remove_column :articles, :published
    remove_column :articles, :published_at
  end 
end

After this, simply add publishable to your model (be sure to add published and published_at to your attr_accessible)

class Article < ActiveRecord::Base
  attr_accessible ...
  publishable
end

After this, when you first mark an Article as published and published_at is not set, published_at will automatically be set to now. If published_at is already set, it will not be changed.

Scopes

  • published -- returns all Article that published=true and published_at is a date in the past
  • unpublished -- returns all Articles that are published=false or published=true and published_at is a date in the future

Instance Methods

  • published? -- returns true if published=true and published_at is a date in the past
  • unpublished? -- returns true if published=false or published=true and published_at is a date in the future

TODO

  • Write tests for generator

Contributing

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

is_publishable's People

Contributors

brendan6 avatar

Watchers

James Cloos avatar Brendan Stennett avatar

Forkers

mhmdhub

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.