has_counter_on 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f216a569999e552a8a811c2be20123f629cb42f4b4a83316fa8f5ae19d1a139f
-  data.tar.gz: b39fb98410d0fd86109126cd4cd94b8c0f36f10e96d81691cc9032564b9c4501
+  metadata.gz: 7ee345c262aca2fe2c606864808605f4852f14b921a83cb6a529bd14d28b1a79
+  data.tar.gz: e31a406d000556d9f99de9ee5d12c04189b95bfebdbb677589dce5f4c30b3cc3
 SHA512:
-  metadata.gz: 0753b5ed10479ffa680b95ea35a14c23b98c5bc4f38c22b122304523b55143f2112b643f9d34dc719fa17618cb06882d667700d6715a179b0fb0d5587999b87d
-  data.tar.gz: 121ed866cbddc6e7bf8415dbcac8037a10590297f97a44ed28c469e531b80218a85688702a3b8e8a7bbff7921f5006b09d056b09162255e2c43259e11bf92042
+  metadata.gz: 6bd2dc9c66d257b106b03e35437b8a9da96bcc4c02a2a150ae00b70249e7e4d0a070fc69d88c75776437b1b4abd43c39dc187722df640f21517e406eca6043cd
+  data.tar.gz: b0837c7d4e690467cd0125b44ee190dabddd21ef9504761f4262746fad3440fa745972aebcea75c6ad7dd606a5d74aa533bf648c609b61c9347f938010da0576

data/README.md

@@ -1,39 +1,110 @@
 # HasCounterOn
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/has_counter_on`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+ActiveRecord counter_cache has been reborn, with ability to specify conditions. Inspired by [counter_cache_with_conditions](https://github.com/skojin/counter_cache_with_conditions) gem.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To use it, add it to your Gemfile:
 
 ```ruby
 gem 'has_counter_on'
 ```
 
-And then execute:
+and bundle:
 
-    $ bundle install
+```
+$ bundle install
+```
 
-Or install it yourself as:
+### After Installation
 
-    $ gem install has_counter_on
+Install migrations
+
+```
+rake has_counter_on:setup
+```
+
+Review the generated migrations then migrate:
+
+```
+rake db:migrate
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Let's say you have a User model and an Article model.
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :articles
+  has_many :published_articles, -> { where(has_published: true) }, class_name: :Article
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :user
+end
+```
 
-## Development
+By using ActiveRecord's `counter_cache`, articles_count can be created as follows: (However, you cannot handle `published_articles_count`)
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+class User < ActiveRecord::Base
+  has_many :articles
+  has_many :published_articles, -> { where(has_published: true) }, class_name: :Article
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :user, counter_cache: true
+end
+```
 
-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](https://rubygems.org).
+**with has_counter_on**, you can handle both of counters like this:
 
-## Contributing
+```ruby
+class User < ActiveRecord::Base
+  has_many :articles
+  has_many :published_articles, -> { where(has_published: true) }, class_name: :Article
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/has_counter_on.
+  has_counter_on :articles
+  has_counter_on :articles, :published_articles_count, has_published: true
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :user
+end
+```
+
+Each counter will be updated automatically like that of the ActiveRecord.
+
+### Complex Conditions
+
+Complex conditions can be expressed as lambda.
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :articles
+  has_many :published_articles, -> { where.not(published_at: nil) }, class_name: :Article
+
+  has_counter_on :articles
+  has_counter_on :articles, :published_articles_count, published_at: -> (value) { value.present? }
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :user
+end
+```
+
+Of course, multiple conditions are available.
+
+```ruby
+class User < ActiveRecord::Base
+  has_counter_on :articles, :featured_articles_count, has_featured: true, has_published: true
+end
+```
+
+## Contributing
 
+Bug reports and pull requests are welcome on [GitHub](https://github.com/mu29/has_counter_on).
 
 ## License
 

data/db/migrate/create_counters_migration.rb

@@ -0,0 +1,14 @@
+AR_VERSION = ActiveRecord.gem_version.version.to_f
+
+class CreateCounters < ActiveRecord::Migration[AR_VERSION]
+  def change
+    create_table :counters do |t|
+      t.string :countable_type, limit: 64
+      t.integer :countable_id, unsigned: true
+      t.string :countable_name
+      t.integer :value
+    end
+
+    add_index :counters, [:countable_id, :countable_type, :countable_name], name: :index_counters_on_countable_id_type_name
+  end
+end

data/lib/has_counter_on/version.rb

@@ -1,3 +1,3 @@
 module HasCounterOn
-  VERSION = '0.1.5'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_counter_on
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Injung Chung
@@ -36,6 +36,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- db/migrate/create_counters_migration.rb
 - has_counter_on.gemspec
 - lib/has_counter_on.rb
 - lib/has_counter_on/countable.rb