has_prerequisite 1.0.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6bf73429257d857c3468aa9f0b6dfc0b3a80ac2
+  data.tar.gz: adf3d755c211db9bf86f13c649f62628ffbed012
+SHA512:
+  metadata.gz: af9b3bf96d8aec2147a6770f103ced6e2a5d044429723d332b135f3cd6d59a98ec0e6cb9168e0f7043c8fa7952e34a308ea9ad0ef2f4042b715a70c0de17995f
+  data.tar.gz: 2247e6c7d0578d9ae4691d665757573da594e4af99ba12b2ffd9c145f8014ce5eed95ab610332abd80005ead6af3958a23cc11ff94888e08ccfd577713a0c9db

data/README.md

@@ -0,0 +1,101 @@
+# HasPrerequisite
+
+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_prerequisite`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_prerequisite'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_prerequisite
+
+## Usage
+
+This gem adds features to your Rails controllers. 
+
+First, in your `ApplicationController` or any controller or method that you want to protect, use `perform_checks` method.
+
+```Ruby
+class ApplicationController < ActionController::Base
+
+before_filter :perform_checks # This will execute on every method of your controller
+
+def index
+  preform_checks # you can call it directly here, especially if you need an instance variable instanciated for a prerequisite
+end
+```
+
+Once you made sure the checks will be performed on the parts of your application you want to protect, define your prerequisites where you want to protect. The `redirection_path` is where you want your user to be redirected to fulfill the prerequisite. Current location will be stored for future redirection, when the prerequisite is fulfilled.
+
+``` Ruby
+class ProfilesController < ApplicationController
+  has_prerequisite :accepted_terms_and_conditions, redirection_path :terms_and_conditions_path
+  
+  private
+  
+  def accepted_terms_and_conditions
+    current_user.accepted_terms_and_conditions_at.present?
+  end
+end
+```
+
+If the path to fulfill the prerequisite is protected by `has_prerequisite` and `perform_checks` (if you're using them in the `ApplicationController` for instance), you can mark it as `fulfilling_prerequisite`
+
+``` Ruby
+class TermsAndConditionsController < ApplicationController
+  fulfilling_prerequisite
+end
+```
+
+Once action was taken by the user and can now access the page they wanted to see at the first place, you can use `step_fulfilled!` to redirect them back to it
+
+``` Ruby
+ class TermsAndConditionsController < ApplicationController
+    fulfilling_prerequisite
+
+    def edit; end
+
+    def update
+      if current_user.update(accepted_terms_and_conditions_at: Datetime.now)
+        step_fulfilled!
+      else
+        render :edit
+      end
+    end
+  end
+```
+
+### Options
+
+You can use a conditionnal to the prerequisite
+
+``` Ruby
+prerequisite :valid_subscription, redirection_path: :new_subscription_path, if: :should_be_charged?
+```
+
+## 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/sophiedeziel/has_prerequisite. 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.
+
+
+## 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,27 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+RSpec::Core::RakeTask.new(:spec)
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasPrerequisite'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+task :default => :spec

data/lib/has_prerequisite.rb

@@ -0,0 +1,63 @@
+require "has_prerequisite/version"
+require "has_prerequisite/railtie" if defined?(Rails)
+require "active_support"
+
+module HasPrerequisite
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :prerequisites, :skipping_checks
+    self.prerequisites = []
+    self.skipping_checks = false
+
+    rescue_from PrerequisiteNotMet, with: :prerequisite_not_met!
+  end
+
+  module ClassMethods
+    def prerequisite(method, redirection_path: nil, **options)
+      prerequisites << { method: method, redirection_path: redirection_path, options: options }
+    end
+
+    def fulfilling_prerequisite
+      self.skipping_checks = true
+    end
+  end
+
+  def step_fulfilled!
+    redirect_to stored_location
+  end
+
+  private
+
+  def perform_checks
+    return if self.class.skipping_checks
+    return unless failing_preriquisite
+    store_location(request.fullpath)
+    raise PrerequisiteNotMet
+  end
+
+  def failing_preriquisite
+    @failing_preriquisite ||= prerequisites.find do |p|
+      !send(p[:method]) if p[:options][:if].nil? || send(p[:options][:if])
+    end
+  end
+
+  def prerequisite_not_met!
+    redirect_to redirect_path
+  end
+
+  def redirect_path
+    return send(failing_preriquisite[:redirection_path]) if failing_preriquisite[:redirection_path].is_a? Symbol
+    failing_preriquisite[:redirection_path]
+  end
+
+  def store_location(path)
+    session[:return_to] = path
+  end
+
+  def stored_location
+    session.delete(:return_to) || root_path
+  end
+
+  class PrerequisiteNotMet < StandardError; end
+end

data/lib/has_prerequisite/railtie.rb

@@ -0,0 +1,9 @@
+module HasPrerequisite
+  class Railtie < Rails::Railtie
+    initializer "has_prerequisite.configure_view_controller" do |app|
+      ActiveSupport.on_load :action_controller do
+        include HasPrerequisite
+      end
+    end
+  end
+end

data/lib/has_prerequisite/version.rb

@@ -0,0 +1,3 @@
+module HasPrerequisite
+  VERSION = '1.0.0.alpha'
+end

data/lib/tasks/has_prerequisite_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :has_prerequisite do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: has_prerequisite
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha
+platform: ruby
+authors:
+- Sophie Déziel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: 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'
+description: Simple authorization method to redirect to specific pages when a prerequisite
+  is not met.
+email:
+- courrier@sophiedeziel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/has_prerequisite.rb
+- lib/has_prerequisite/railtie.rb
+- lib/has_prerequisite/version.rb
+- lib/tasks/has_prerequisite_tasks.rake
+homepage: http://github.com/sophiedeziel/has_prerequisite
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple authorization method to redirect to specific pages when a prerequisite
+  is not met.
+test_files: []