everett 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37f958aff948ab1bc2cff07f7f26b06048fed9ff
-  data.tar.gz: ca5575ca0e54d9b6f3d4d028c404b072be20342b
+  metadata.gz: b9a4844f265ec031ab1001d8f5600f4f5d14c005
+  data.tar.gz: 78ec39f0f8bbfc0e651c416ea7ee14a086dee58b
 SHA512:
-  metadata.gz: 43dcaf294aa9f1e96dcbd524b92a0649d4541fac2612276906f9fb97462872e010ec882fd838ad1df1b3162d9f02912aa98ddf90c4ee8ed3729d9e140b1a4c31
-  data.tar.gz: 7fca6c99080d015b2c18be58a43119be4679cd7eef5dceb206c3a1b2209feccf833e936676d8f56b102951b58ab18d44f8277444e61d77ecc864a91e52330fb6
+  metadata.gz: 40912e945e0961017752771bd31667046812b76a1de29da451c795b4dff5645beecc6a08c19e42ee0246eb7a46a15d4b25e000cec9659b99b9a7c3937b168859
+  data.tar.gz: a414083ee2f1b2604811c036a6f8a3b0c9de71e23c0d1b18de895f9bb047a9c8efe0c60b29311427a0ef5d0cbf9e878e0a6a6ce524fbb7efcf0965569a7a2120

data/README.md

@@ -1,28 +1,72 @@
 # Everett
-Short description and motivation.
+[![Gem Version](https://badge.fury.io/rb/everett.svg)](http://badge.fury.io/rb/everett)
+[![Build Status](https://travis-ci.org/yasaichi/everett.svg?branch=master)](https://travis-ci.org/yasaichi/everett)
+[![Code Climate](https://codeclimate.com/github/yasaichi/everett/badges/gpa.svg)](https://codeclimate.com/github/yasaichi/everett)
+[![Test Coverage](https://codeclimate.com/github/yasaichi/everett/badges/coverage.svg)](https://codeclimate.com/github/yasaichi/everett/coverage)
 
-## Usage
-How to use my plugin.
+Everett is a simple observer for Rails 5 ActiveRecord.
 
 ## Installation
-Add this line to your application's Gemfile:
+Put this in your Gemfile:
 
 ```ruby
 gem 'everett'
 ```
 
-And then execute:
-```bash
-$ bundle
+Run the installation generator with:
+
+```sh
+$ rails g everett:install
+```
+
+They will install the initializer into `config/initializers/everett.rb`.
+
+## Usage
+Observers allow you to implement trigger-like behavior outside the original classes.  
+You can put them anywhere, for example `app/observers/comment_observer.rb`:
+
+```ruby
+class CommentObserver < Everett::Observer
+  def after_create(comment)
+    Rails.logger.info("New comment was posted.")
+  end
+
+  def after_destroy(comment)
+    Rails.logger.info("Comment with an id of #{comment.id} was destroyed.")
+  end
+end
+```
+
+This observer prints a log message when specific callbacks are triggered.
+
+Like [rails-observers](https://github.com/rails/rails-observers), the convention is to name observers after the class they observe.  
+If you need to change this, or want to use one observer for several classes, use `observe`:
+
+```ruby
+class NotificationsObserver < Everett::Observer
+  observe :comment, :like
+
+  def after_create_commit(record)
+    # notifiy users of new comment or like
+  end
+end
 ```
 
-Or install it yourself as:
-```bash
-$ gem install everett
+Note that you must register observers first to activate them.  
+This can be done by adding the following line into `config/initializers/everett.rb`:
+
+```ruby
+config.observers = :comment_observer, :notifications_observer
 ```
 
 ## Contributing
-Contribution directions go here.
+You should follow the steps below.
+
+1. [Fork the repository](https://help.github.com/articles/fork-a-repo/)
+2. Create a feature branch: `git checkout -b add-new-feature`
+3. Commit your changes: `git commit -am 'add new feature'`
+4. Push the branch: `git push origin add-new-feature`
+4. [Send us a pull request](https://help.github.com/articles/about-pull-requests/)
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,23 +1,11 @@
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Everett'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-
-
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/everett.rb

@@ -1,3 +1,32 @@
+require "everett/configuration"
+require "everett/observer"
+require "everett/subject"
+require "everett/utils"
+require "everett/version"
+
+if defined? Rails
+  require "everett/railtie"
+end
+
 module Everett
-  # Your code goes here...
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= ::Everett::Configuration.instance
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def enable
+      configuration.instantiated_observers.each do |observer|
+        observer
+          .observed_classes
+          .map { |klass| ::Everett::Subject[klass] }
+          .each { |subject| subject.add_observer(observer) }
+      end
+    end
+  end
 end

data/lib/everett/configuration.rb

@@ -0,0 +1,38 @@
+require "everett/utils"
+require "singleton"
+
+module Everett
+  class Configuration
+    include ::Singleton
+    include ::Everett::Utils
+
+    attr_reader :observers
+
+    def initialize
+      @observers = []
+    end
+
+    def instantiated_observers
+      @observers.map { |observer| instantiate_observer(observer) }
+    end
+
+    def observers=(observers)
+      @observers = Array(observers)
+    end
+
+    def reset
+      @observers.clear
+    end
+
+    private
+
+    def instantiate_observer(observer)
+      constant = constantize(observer)
+      return constant.instance if constant.respond_to?(:instance)
+
+      raise ::TypeError,
+        "#{constant} must be a lowercase, underscored class name " +
+        "(or the class itself) responding to the method :instance."
+    end
+  end
+end

data/lib/everett/observer.rb

@@ -0,0 +1,42 @@
+require "active_support"
+require "active_support/inflector"
+require "everett/utils"
+require "set"
+require "singleton"
+
+module Everett
+  class Observer
+    include ::Singleton
+    include ::Everett::Utils
+
+    class << self
+      private
+
+      def observe(*models)
+        instance.observe(*models)
+      end
+    end
+
+    def initialize
+      @observed_classes = ::Set.new
+    end
+
+    def observe(*models)
+      models.map! { |model| constantize(model) }.compact!
+      !!@observed_classes.merge(models)
+    end
+
+    def observed_classes
+      @observed_classes.empty? ? Array(default_class) : @observed_classes.to_a
+    end
+
+    private
+
+    def default_class
+      md = /\A(?<class_name>.*)Observer\z/.match(self.class.name)
+      md[:class_name].constantize if md
+    rescue ::NameError
+      nil
+    end
+  end
+end

data/lib/everett/railtie.rb

@@ -0,0 +1,9 @@
+require "rails/railtie"
+
+module Everett
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      ::Everett.enable
+    end
+  end
+end

data/lib/everett/subject.rb

@@ -0,0 +1,40 @@
+require "active_record"
+require "set"
+
+module Everett
+  class Subject
+    CALLBACKS = ::Set[
+      *::ActiveRecord::Callbacks::CALLBACKS.map(&:to_sym),
+      *%i(create update destroy).map { |fire_on| :"after_#{fire_on}_commit" }
+    ].freeze
+
+    class << self
+      private :new
+
+      def [](model)
+        instances.fetch(model) { |key| instances[key] = new(model) }
+      end
+
+      private
+
+      def instances
+        @instances ||= {}
+      end
+    end
+
+    def initialize(model)
+      @model = model
+      @observers = ::Set.new
+    end
+
+    def add_observer(observer)
+      return false if @observers.include?(observer)
+
+      callbacks = CALLBACKS.select { |callback| observer.respond_to?(callback) }
+      return false if callbacks.empty?
+
+      callbacks.each { |callback| @model.public_send(callback, observer) }
+      !!@observers.add(observer)
+    end
+  end
+end

data/lib/everett/utils.rb

@@ -0,0 +1,14 @@
+require "active_support"
+require "active_support/inflector"
+
+module Everett
+  module Utils
+    module_function
+
+    def constantize(underscored_name_or_constant)
+      underscored_name_or_constant.respond_to?(:to_sym) ?
+        underscored_name_or_constant.to_s.camelize.constantize :
+        underscored_name_or_constant
+    end
+  end
+end

data/lib/everett/version.rb

@@ -1,3 +1,3 @@
 module Everett
-  VERSION = '0.1.0'
+  VERSION = "0.2.0".freeze
 end

data/lib/generators/everett/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create a Everett initializer
+
+Example:
+    rails generate everett:install
+
+    This will create:
+        config/initializers/everett.rb

data/lib/generators/everett/install/install_generator.rb

@@ -0,0 +1,11 @@
+module Everett
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_initializer_file
+        template "everett.rb", "config/initializers/everett.rb"
+      end
+    end
+  end
+end

data/lib/generators/everett/install/templates/everett.rb

@@ -0,0 +1,4 @@
+Everett.configure do |config|
+  # Activate observers that should always be running.
+  # config.observers = :my_observer
+end

metadata

@@ -1,35 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: everett
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - yasaichi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-10 00:00:00.000000000 Z
+date: 2016-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - ">="
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-coolline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -55,7 +161,15 @@ files:
 - README.md
 - Rakefile
 - lib/everett.rb
+- lib/everett/configuration.rb
+- lib/everett/observer.rb
+- lib/everett/railtie.rb
+- lib/everett/subject.rb
+- lib/everett/utils.rb
 - lib/everett/version.rb
+- lib/generators/everett/install/USAGE
+- lib/generators/everett/install/install_generator.rb
+- lib/generators/everett/install/templates/everett.rb
 - lib/tasks/everett_tasks.rake
 homepage: https://github.com/yasaichi/everett
 licenses: