douglas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6429b33ba850b79cbe5f57063e76476eb34365c7
+  data.tar.gz: c4a15d8e66cdebcd25161a0f729faa7bf41f159e
+SHA512:
+  metadata.gz: 2f4638939b3c1b8b34920a1b3715361e5e80611ffe8ad94f6367fd74d55b17931a8727f9a11105ccec5201e51e1a7ad309ad1e94d5426d54ebb18b95e141fc7f
+  data.tar.gz: a7e6f13f2aedfe3474438125385a9eebf1a0de8bd42860e6a715cdeb54d269f4f2a7655affc38933f62f792dae3702511ded817730194965e99d1fd8940a717f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ileeftimov@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in douglas.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ilija Eftimov
+
+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,127 @@
+# Douglas
+
+[![Active Development](https://img.shields.io/badge/Maintenance%20Level-Actively%20Developed-brightgreen.svg)](https://gist.github.com/cheerfulstoic/d107229326a01ff0f333a1d3476e068d)
+
+**Status: Under heavy development**
+
+Douglas is a Ruby gem that adds the ability to easily add `created_by` and
+`updated_by` attributes to any ActiveRecord model.
+It allows easy user-stamping for any Active Record model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'douglas'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+### Built-in generator
+
+When added in a Rails application, Douglas adds a generator which enables the users
+to easily generate migrations which need to be stamped.
+
+To generate these migrations, you can use Douglas' `table` generator:
+
+```
+rails generate douglas:table NAME
+```
+
+This will generate a migration:
+
+```
+create  db/migrate/20170322225126_add_created_by_and_updated_by_to_<model-name>.rb
+```
+
+The contents of this migration will be:
+
+```ruby
+class AddCreatedByAndUpdatedByTo<model-name> < ActiveRecord::Migration[5.0]
+  def change
+    add_column :<model-name>, :created_by, :integer
+    add_column :<model-name>, :updated_by, :integer
+
+    add_index :<model-name>, :created_by
+    add_index :<model-name>, :updated_by
+  end
+end
+```
+
+### Plug it into a controller
+
+In your `ApplicationController` add a `before_action`:
+
+```ruby
+class ApplicationController
+  before_action :set_douglas_the_stamper
+end
+```
+
+This will enable `Douglas` to know the current user that peroforms the action (create/update) on an model object.
+
+### Use it in models
+
+In the model (that you ran the generate task for), add this:
+
+```ruby
+class User < ApplicationRecord
+  has_stamps
+end
+```
+
+This will populat the `created_by` and `updated_by` attributes accordintly. Under
+the hood this injects callbacks that are executed before create and update.
+
+### Use it in console
+
+Since the `{created,updated}_by` columns cannot be `null` it means that the `Douglas.the_stamper` has to always be set to a value. This is normally done via the controller `before_filter` method, but in console you have to use the `Douglas.with_stamper` method. This method expects two arguments, an identifier of the user that does the action and a block. This means that the user will be logged as the person that has done the actions within the block.
+
+For example:
+
+```
+>> Douglas.with_stamper(123) do
+?>   p = Post.first
+>>   p.body = 'Lorem ipsum dolor sit amet''
+>>   p.save
+>> end
+```
+
+The `Post` will be updated, and the `updated_by` attribute will be set to the first passed argument - `123`.
+
+## Progress
+
+- [x] Add migrations generator (https://github.com/fteem/douglas/pull/1)
+- [x] Find way to hijack `current_user` and store in `RequestStore`
+- [x] Find way to plug-in `Douglas` in model lifecycle
+- [ ] Make it work with Rails.version < 3.2
+- [ ] Make logged attribute (currently `id`) to be configurable
+- [ ] Add `deleted_by` attribute?
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/douglas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Why Douglas?
+
+Named after [Douglas "Doug" **Stamper**](http://house-of-cards.wikia.com/wiki/Doug_Stamper),
+President Frank Underwood's White House Chief of Staff and former director of strategy.
+
+![](http://thediscussion.net/main/wp-content/uploads/2014/08/Doug-n-Brick-S1.gif)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "douglas"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/douglas.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'douglas/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'douglas'
+  spec.version       = Douglas::VERSION
+  spec.authors       = ['Ilija Eftimov']
+  spec.email         = ['ileeftimov@gmail.com']
+
+  spec.summary       = 'Douglas adds stamps to any ActiveRecord model'
+  spec.description   = 'Douglas adds stamps to any ActiveRecord model, like {created,updated}_by'
+  spec.homepage      = 'https://github.com/fteem/douglas'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'activerecord', '>= 4.0.0', '< 5.1'
+  spec.add_runtime_dependency 'request_store', '~> 1.3'
+end

data/lib/douglas.rb

@@ -0,0 +1,31 @@
+require 'request_store'
+require 'douglas/version'
+require 'douglas/model'
+
+module Douglas
+  class << self
+    def the_stamper
+      RequestStore.store[:the_stamper]
+    end
+
+    def the_stamper= user
+      RequestStore.store[:the_stamper] = user
+    end
+
+    def with_stamper user
+      return unless block_given?
+
+      self.the_stamper = user
+      yield
+      self.the_stamper = nil
+    end
+  end
+end
+
+if defined?(::Rails) && ActiveRecord::VERSION::STRING >= '3.2'
+  require 'douglas/frameworks/rails'
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.send :extend, Douglas::Model
+end

data/lib/douglas/frameworks/rails.rb

@@ -0,0 +1 @@
+require 'douglas/frameworks/rails/controller'

data/lib/douglas/frameworks/rails/controller.rb

@@ -0,0 +1,34 @@
+module Douglas
+  module Rails
+    # Extensions to rails controllers. Provides convenient ways to pass certain
+    # information to the model layer via `the_stamper`.
+    module Controller
+      protected
+
+      # Returns the user who is responsible for any changes that occur.
+      # By default this calls `current_user` and returns the result.
+      #
+      # Override this method in your controller to call a different
+      # method, e.g. `current_person`, or anything you like.
+      def user_for_douglas
+        return unless defined?(current_user)
+        ActiveSupport::VERSION::MAJOR >= 4 ? current_user.try!(:id) : current_user.try(:id)
+      rescue NoMethodError
+        current_user
+      end
+
+      private
+
+      # Tells Douglas who is responsible for any changes that occur
+      def set_douglas_the_stamper
+        ::Douglas.the_stamper = user_for_douglas
+      end
+    end
+  end
+end
+
+if defined?(::ActionController)
+  ::ActiveSupport.on_load(:action_controller) do
+    include ::Douglas::Rails::Controller
+  end
+end

data/lib/douglas/model.rb

@@ -0,0 +1,9 @@
+require 'douglas/model_config'
+
+module Douglas
+  module Model
+    def has_stamps
+      Douglas::ModelConfig.new(self).setup
+    end
+  end
+end

data/lib/douglas/model_config.rb

@@ -0,0 +1,18 @@
+module Douglas
+  class ModelConfig
+    def initialize(model_class)
+      @model_class = model_class
+    end
+
+    # Set up `@model_class` for Douglas. Installs callbacks.
+    def setup
+      @model_class.before_create do |r|
+        r.created_by = Douglas.the_stamper
+      end
+
+      @model_class.before_save(on: :update) do |r|
+        r.updated_by = Douglas.the_stamper
+      end
+    end
+  end
+end

data/lib/douglas/version.rb

@@ -0,0 +1,3 @@
+module Douglas
+  VERSION = "0.1.0"
+end

data/lib/generators/douglas/table_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/active_record'
+
+module Douglas
+  module Generators
+    class TableGenerator < ::Rails::Generators::NamedBase
+      include ::Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'Create migration for for a table that should be stamped'
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_douglas_migration
+        migration_template 'migration.rb', "db/migrate/add_created_by_and_updated_by_to_#{table_name}.rb", migration_version: migration_version
+      end
+
+      def migration_version
+        if rails5?
+          "[#{::Rails::VERSION::MAJOR}.#{::Rails::VERSION::MINOR}]"
+        end
+      end
+
+      def rails5?
+        ::Rails.version.start_with? '5'
+      end
+    end
+  end
+end

data/lib/generators/douglas/templates/migration.rb

@@ -0,0 +1,9 @@
+class AddCreatedByAndUpdatedByTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :<%= table_name %>, :created_by, :integer, null: false
+    add_column :<%= table_name %>, :updated_by, :integer, null: false
+
+    add_index :<%= table_name %>, :created_by
+    add_index :<%= table_name %>, :updated_by
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: douglas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ilija Eftimov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Douglas adds stamps to any ActiveRecord model, like {created,updated}_by
+email:
+- ileeftimov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- douglas.gemspec
+- lib/douglas.rb
+- lib/douglas/frameworks/rails.rb
+- lib/douglas/frameworks/rails/controller.rb
+- lib/douglas/model.rb
+- lib/douglas/model_config.rb
+- lib/douglas/version.rb
+- lib/generators/douglas/table_generator.rb
+- lib/generators/douglas/templates/migration.rb
+homepage: https://github.com/fteem/douglas
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Douglas adds stamps to any ActiveRecord model
+test_files: []
+has_rdoc: