https://github.com/jasl/acts_as_priceable

a easy way to store price as cents in database, but keep usability
https://github.com/jasl/acts_as_priceable

Last synced: 9 days ago
JSON representation

a easy way to store price as cents in database, but keep usability

• Host: GitHub
• URL: https://github.com/jasl/acts_as_priceable
• Owner: jasl
• License: mit
• Created: 2013-12-27T09:12:11.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-12-27T18:43:28.000Z (about 11 years ago)
• Last Synced: 2024-12-24T00:14:04.946Z (18 days ago)
• Language: Ruby
• Size: 113 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
ActsAsPriceable

====

A easy way to store price as cents in database, but keep usability. It designed for ActiveModel, not dependent Rails or

ActiveRecord.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'acts_as_priceable', github: 'jasl/acts_as_priceable'

```

And then execute:

    $ bundle

## Usage

Say you have a model, `Llama`.  You can buy `Llama`s for a `cost`.  Let's add the `cost` to the `Llama` model.

First, you need define a column named `cost_in_cents` for persistence, this is a convention,

but you can change it by `suffix` option.

Now we just need to tell model that the `cost` field is act_as_priceable

```ruby

# app/models/llama.rb

class Llama < ActiveRecord::Base

  acts_as_priceable :cost

end

```

**Important for Mongoid user: you need add `include ActsAsPriceable` in your model.**

And now lets check it out in the console

```ruby

>> llama = Llama.last

>> llama.cost # => nil

>> llama.cost = 100

>> llama.cost_in_cents # => 10000

>> llama.cost # => 100

```

By default, `cost` should be a `BigDecimal`,

if you want to present price as other type like [Money](https://github.com/RubyMoney/money), can give `class` option.

Isn't that special. So go, and add prices easily to your models, with ActsAsPriceable.

PS: `acts_as_priceable` can take more than one field at a time, so go ahead and load it up like a baked potato.

```ruby

acts_as_priceable :retail_price, :employee_price, :cost

```

PS2: how it powerful

```ruby

acts_as_priceable :charge, initializer: ->(price_in_cents) { Money.new (price_in_cents), 'CNY' }

```

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

## License

This project rocks and uses MIT-LICENSE.