stance 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 593f0e612e270f03cdacbe2338c181287094558be03d721588db3ab54b094f52
+  data.tar.gz: 20fb411cd404fa4762e195c44a4a730670ea07862499d50b12f855b41d97cc22
+SHA512:
+  metadata.gz: cdd07c0676ff44d4ebf2137747d573992c7dc7015c00b3520452aa2478aad46fc4bbf94b8c9d22cd90380a10dad9be96ab091945e1842e3f0529c2d7f70641ab
+  data.tar.gz: 1b1939a3e0b0686172b4a0edf7fa91cea2fac0a5c7257a18f7003f117bd43674d772692643f9d8bfdc96776a8f00eb8c451b6451a9c911e18673e591942245ce

data/.autotest

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'autotest/suffix'
+require 'autotest/restart'
+require 'autotest/bundler'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/autorun'
+  at.add_exception '.git'
+  at.add_exception %r{^\./test/internal/db/.+\.sqlite}
+  at.add_exception %r{^\./test/internal/(?:log|public|tmp|app/assets)}
+end

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/internal/db/*.sqlite

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  NewCops: enable
+Style/Documentation:
+  Enabled: false
+Layout/LineLength:
+  Max: 100
+Metrics/MethodLength:
+  Max: 12

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joel@developwithstyle.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stance.gemspec
+gemspec
+
+gem 'autotest-suffix'
+gem 'combustion'
+gem 'minitest'
+gem 'minitest-autotest'
+gem 'minitest-focus'
+gem 'rake', '~> 12.0'
+gem 'rubocop'
+gem 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,121 @@
+PATH
+  remote: .
+  specs:
+    stance (0.1.0)
+      activerecord (>= 5)
+      multi_json
+      railties (>= 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    autotest-suffix (1.1.0)
+    builder (3.2.4)
+    combustion (1.3.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    erubi (1.9.0)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    minitest-autotest (1.1.1)
+      minitest-server (~> 1.0)
+      path_expander (~> 1.0)
+    minitest-focus (1.2.1)
+      minitest (>= 4, < 6)
+    minitest-server (1.0.6)
+      minitest (~> 5.0)
+    multi_json (1.14.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    path_expander (1.1.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest-suffix
+  combustion
+  minitest
+  minitest-autotest
+  minitest-focus
+  rake (~> 12.0)
+  rubocop
+  sqlite3
+  stance!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Joel Moss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Stance - Simple Events for Rails apps
+
+```ruby
+class AppointmentEvents < Stance::Events
+  # Define events.
+  event :my_event
+  event :some_event
+
+  # Namespaced events
+  event 'offers.create'
+  event 'offers.delete'
+
+  # Singleton event: only one event with this name can exist for the same subject.
+  event :my_event, singleton: true
+
+  # Optionally, create a class for an event.
+  class SomeEvent < Stance::Event
+    # Return false if you do not want the event to be created.
+    def callable?
+      false
+    end
+
+    def call
+      # do something when the event is created.
+    end
+  end
+end
+
+# Publish events from the model
+Appointment.find(1).publish_event :some_event
+Appointment.find(1).publish_event 'offers.create'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stance'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install stance
+
+Run the installer to generate the migration, and then run the migration:
+
+    $ rails g stance:install
+    $ rails db:migrate
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/stance. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joelmoss/stance/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Stance project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joelmoss/stance/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/app/models/stance/event_record.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+
+class JSONWithIndifferentAccess
+  def self.load(str)
+    return str unless str
+
+    obj = HashWithIndifferentAccess.new(MultiJson.load(str))
+    obj.freeze
+    obj
+  end
+
+  def self.dump(obj)
+    MultiJson.dump(obj)
+  end
+end
+
+module Stance
+  class EventRecord < ActiveRecord::Base
+    belongs_to :subject, polymorphic: true
+
+    scope :active, -> { where dismissed_at: nil }
+    scope :dismissed, -> { where.not dismissed_at: nil }
+
+    def self.table_name_prefix
+      'stance_'
+    end
+
+    def self.dismiss_all
+      active.each(&:dismiss)
+    end
+
+    def to_s
+      name
+    end
+
+    def event_class_name
+      @event_class_name ||= "#{subject.model_name.name}Events::#{name.tr('.', '/').classify}"
+    end
+
+    def event_class
+      @event_class ||= event_class_name.constantize
+    end
+
+    def dismissed?
+      dismissed_at.present?
+    end
+
+    def active?
+      !dismissed?
+    end
+
+    def dismiss
+      update_attribute :dismissed_at, Time.current
+    end
+
+    unless connection.adapter_name =~ /postg|mysql/i
+      serialize :metadata, ::JSONWithIndifferentAccess
+    end
+  end
+end

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/generators/stance/install_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module Stance
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.join(__dir__, 'templates')
+
+      desc 'Install Stance, including a database migration.'
+
+      def copy_migration
+        migration_template 'migration.rb', 'db/migrate/create_stance_event_record.rb',
+                           migration_version: migration_version
+      end
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      def properties_type
+        case ActiveRecord::Base.connection_config[:adapter].to_s
+        when /postg/i # postgres, postgis
+          'jsonb'
+        when /mysql/i
+          'json'
+        else
+          'text'
+        end
+      end
+    end
+  end
+end

data/lib/generators/stance/templates/migration.rb.tt

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :stance_event_records do |t|
+      t.string :name
+      t.<%= properties_type %> :metadata
+      t.belongs_to :subject, polymorphic: true
+      t.datetime :dismissed_at, index: true
+      t.timestamps
+    end
+  end
+end

data/lib/stance.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'stance/version'
+require 'stance/engine'
+
+module Stance
+  class EventNotFound < StandardError; end
+
+  autoload :Events, 'stance/events'
+  autoload :Event, 'stance/event'
+  autoload :Eventable, 'stance/eventable'
+end

data/lib/stance/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module Stance
+  class Engine < ::Rails::Engine
+    isolate_namespace Stance
+
+    # initializer 'active_record.include_event_concern' do
+    #   ActiveSupport.on_load(:active_record) do
+    #     ActiveRecord::Base.include Stance::EventConcern
+    #   end
+    # end
+  end
+end

data/lib/stance/event.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Stance
+  class Event
+    attr_reader :record, :options
+
+    delegate :subject, :name, to: :record
+
+    def initialize(name, subject, metadata, options)
+      @options = { singleton: false }.merge(options)
+      @record = Stance::EventRecord.new(name: name, subject: subject, metadata: metadata)
+    end
+
+    def valid?
+      # If event is a singleton, check there is no other active event with the same name. If there
+      # is, return false.
+      return false if options[:singleton] && subject.events.active.exists?(name: name)
+
+      callable? && record.save
+    end
+
+    def callable?
+      true
+    end
+
+    def call
+      true
+    end
+  end
+end

data/lib/stance/eventable.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Stance
+  module Eventable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :events, as: :subject, class_name: 'Stance::EventRecord'
+    end
+
+    # Publish an event.
+    #
+    # Creates an EventRecord with the given `name`, `metadata` and self as the 'subject'.
+    #
+    # Returns the results of `call`ing the event class.
+    def publish_event(name, metadata = {})
+      name = name.to_s
+      ensure_event! name
+
+      # Find the Event class - if any - and call it. Falls back to Stance::Event.
+      event_class_name = "#{events_class_name}::#{name.to_s.tr('.', '/').classify}"
+      ev = event_class(event_class_name).new(name, self, metadata, events_class.events[name])
+
+      Stance::EventRecord.transaction do
+        ev.valid? && ev.call
+      end
+    end
+
+    private
+
+    # Raise EventNotFound if the event has not been defined.
+    def ensure_event!(name)
+      return if events_class.events.keys.include?(name)
+
+      raise Stance::EventNotFound, "Event `#{name}` not found"
+    end
+
+    def events_class
+      @events_class ||= events_class_name.constantize
+    end
+
+    def events_class_name
+      @events_class_name ||= "#{model_name.name}Events"
+    end
+
+    def event_class(name)
+      name.constantize
+    rescue NameError
+      Stance::Event
+    end
+  end
+end

data/lib/stance/events.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Stance
+  class Events
+    class << self
+      attr_reader :events
+
+      def event(name, options = {})
+        @events ||= {}
+        @events[name.to_s] = options
+      end
+    end
+  end
+end

data/lib/stance/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stance
+  VERSION = '0.1.0'
+end

data/stance.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/stance/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stance'
+  spec.version       = Stance::VERSION
+  spec.authors       = ['Joel Moss']
+  spec.email         = ['joel@developwithstyle.com']
+
+  spec.summary       = 'Event System for Rails'
+  spec.homepage      = 'https://github.com/joelmoss/stance'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 5'
+  spec.add_dependency 'multi_json'
+  spec.add_dependency 'railties', '>= 5'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: stance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Moss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+description: 
+email:
+- joel@developwithstyle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".autotest"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/stance/event_record.rb
+- config.ru
+- lib/generators/stance/install_generator.rb
+- lib/generators/stance/templates/migration.rb.tt
+- lib/stance.rb
+- lib/stance/engine.rb
+- lib/stance/event.rb
+- lib/stance/eventable.rb
+- lib/stance/events.rb
+- lib/stance/version.rb
+- stance.gemspec
+homepage: https://github.com/joelmoss/stance
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joelmoss/stance
+  source_code_uri: https://github.com/joelmoss/stance
+  changelog_uri: https://github.com/joelmoss/stance/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Event System for Rails
+test_files: []