scram 0.1.0

data/lib/scram/core_ext/symbol_extensions.rb

@@ -0,0 +1,14 @@
+# Refinements to the Symbol class
+module SymbolExtensions
+  refine Symbol do
+    # Converts self to a boolean if it is :allow, :abstain, :deny. Assumes that abstain means false.
+    # @return [Boolean] Boolean representation of allow, abstain, or deny. Abstain means false.
+    # @raise [NotImplementedError] If unsupported symbol is converted (not :allow, :abstain, :deny)
+    def to_bool
+      raise NotImplementedError("Cannot convert #{self} to a boolean! #to_bool only supports :allow, :abstain and :deny.") unless %i[allow abstain deny].include? self
+      return true if self == :allow
+      return false if self == :abstain
+      return false if self == :deny
+    end
+  end
+end

data/lib/scram/dsl/builders.rb

@@ -0,0 +1,43 @@
+module Scram::DSL
+  # DSL Builders
+  module Builders
+    # Base class for DSL Builder.
+    # Executes initializer block within context of the builder.
+    class Builder
+        def initialize(&block)
+          instance_exec(&block)
+        end
+    end
+
+    # TODO: Flatten comparatorbuilder and conditionbuilder into one "DictionaryBuilder"
+    # Builder used to create comparators.
+    class ComparatorBuilder < Builder
+      attr_accessor :comparators
+
+      def initialize(&block)
+        @comparators = {}
+        super(&block)
+      end
+
+      def comparator name, &block
+        @comparators[name] = block
+      end
+    end
+
+    # Builder used to create conditions.
+    class ConditionBuilder < Builder
+      attr_accessor :conditions
+
+      def initialize(&block)
+        @conditions = {}
+        super(&block)
+      end
+
+      def condition variable, &block
+        @conditions[variable] = block
+      end
+    end
+
+  end
+
+end

data/lib/scram/dsl/definitions.rb

@@ -0,0 +1,36 @@
+module Scram::DSL
+  # Default definitions from builders
+  module Definitions
+    # Adds a custom comparator using a builder
+    # @param builder [Scram::Builders::ComparatorBuilder] Builder to merge into the usable comparators
+    def self.add_comparators(builder)
+      COMPARATORS.merge!(builder.comparators)
+    end
+
+    # Default comparators.
+    # @note These names are used within the DB as key names for conditions. Pay attention when adding them,
+    #   and plan not to be changing them.
+    # TODO: Inclusive inequalities
+    COMPARATORS = Builders::ComparatorBuilder.new do
+      comparator :equals do |a, b|
+        a == b
+      end
+
+      comparator :greater_than do |a, b|
+        a > b
+      end
+
+      comparator :less_than do |a, b|
+        a < b
+      end
+
+      comparator :includes do |a, b|
+        a.send(:include?, b)
+      end
+
+      comparator :not_equals do |a, b|
+        a != b
+      end
+    end.comparators
+  end
+end

data/lib/scram/dsl/model_conditions.rb

@@ -0,0 +1,50 @@
+module Scram::DSL
+  # Module for Models to include to be able to define special condition variables in their targets
+  # @note Changes behavior of method_missing! Calling a method prefixed with * will search for scram conditions to invoke
+  module ModelConditions
+    def self.included(base_class)
+      base_class.extend ClassMethods
+    end
+
+    module ClassMethods
+      # @return [Hash] Mapping of condition names to Procs to execute them
+      attr_accessor :scram_conditions
+
+      # Method meant to be used in the including class to begin defining conditions
+      #
+      # Example
+      #   scram_define do
+      #     condition :foo do
+      #       |instance| "hello world"
+      #     end
+      #   end
+      def scram_define(&block)
+        @scram_conditions = Builders::ConditionBuilder.new(&block).conditions
+      end
+    end
+
+    # Methods starting with an asterisk are tested for DSL defined conditions
+    def method_missing(method, *args)
+      if method.to_s.starts_with? "*"
+        condition_name = method.to_s.split("*")[1].to_sym
+        conditions = self.class.scram_conditions
+        if conditions && !conditions[condition_name].nil?
+          return conditions[condition_name].call(self)
+        end
+      end
+      super
+    end
+
+    # Allow DSL condition methods to show up as methods (i.e fix #respond_to?)
+    def respond_to_missing?(method, include_private = false)
+      if method.to_s.starts_with? "*"
+        condition_name = method.to_s.split("*")[1].to_sym
+        conditions = self.class.scram_conditions
+        if conditions && !conditions[condition_name].nil?
+          return true
+        end
+      end
+      super
+    end
+  end
+end

data/lib/scram/engine.rb

@@ -0,0 +1,15 @@
+require "rails/mongoid"
+require "mongoid"
+
+module Scram
+  class Engine < ::Rails::Engine
+    isolate_namespace Scram
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/scram/version.rb

@@ -0,0 +1,3 @@
+module Scram
+  VERSION = '0.1.0'
+end

data/lib/tasks/scram_tasks.rake

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

data/spec/config/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  clients:
+    default:
+      database: scram_db
+      hosts:
+        - localhost:27017

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link scram_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require_relative 'boot'
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+require "active_job/railtie"
+require "action_cable/engine"
+require "rails/test_unit/railtie"
+require "sprockets/railtie"
+
+Bundler.require(*Rails.groups)
+require "scram"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!