active_flags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bfaa18819393cb9c991c16d105fdb92b6c8f062142f1ca02dc11181612e96fbe
+  data.tar.gz: f1a371f52a51fa31d31ffb5b51173ae35034060098991d8ee12e78d64791ec04
+SHA512:
+  metadata.gz: 9470fa8f5b37a712f228d367747d2c56562c41f7ee13c2060e40c821bc4a8092a9bed67a3efb23ef0c79b0f060f0a530f7c9edefc426fd8a49bfd74dfb98265f
+  data.tar.gz: b85d3dcf82c39838dd7d1e476c142c1f1a29cc766b2fad4756f8e84d59f5521cc32b5a3cc508cda174baa412c221ed2d0f1ebb3ad9276de886f5d83fa3dd8f2a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Nathan Huberty
+
+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 @@
+# ActiveFlags
+Active Flags allows you to use automatic flags on models. You won't have to create useless booleans with view logic in your core tables. They should not have been there in the first place, let Active Flags handle them for you!
+
+## Installation
+
+(You need at least rails 5.0 to use the gem)
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_flags'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active_flags
+```
+
+Then import Active Flags' migrations
+```bash
+$ bin/rails active_flags:install:migrations
+```
+
+Adapt them if needed and run db:migrate
+```bash
+$ rails db:migrate
+```
+
+## Usage
+Let's say you're building a networking app, with users connecting each other.
+But you want it to be so relevant that it only makes active users (connecting often enough) visibles on the search.
+To do so you would add a boolean `active` or `visible` in your user's table.
+
+It works, but it is view logic and shouldn't be there. Imagine your app is growing and you have 10 more booleans on your user table, and then 10 more on another model. It will only pollute your tables.
+
+Once Active Flags is set, you can easily declare that your model has flags like that:
+
+```ruby
+class User < ApplicationRecord
+  has_flags :visible, :active
+end
+```
+
+And that's it!
+You can now add flags on a user like that:
+
+```ruby
+user.flags = { visible: 'true', active: 'true' }
+user.save!
+```
+
+A flag won't be saved if you don't explicitly declare it as has_flags attributes in the model.
+
+But if you do not want to handle explicit flags, you could also declare:
+
+```ruby
+class User < ApplicationRecord
+  has_flags
+end
+```
+
+And then you can declare as much flags as you want with no restriction:
+```ruby
+user.update!(flags: { visible: 'true', active: 'true', diet: 'vegan', power: 'super saiyan' })
+```
+
+## Contributing
+https://github.com/FidMe/active_flags
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  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    = 'ActiveFlags'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/active_flags_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/active_flags .css

data/app/assets/stylesheets/active_flags/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/app/controllers/active_flags/application_controller.rb

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

data/app/helpers/active_flags/application_helper.rb

@@ -0,0 +1,4 @@
+module ActiveFlags
+  module ApplicationHelper
+  end
+end

data/app/jobs/active_flags/application_job.rb

@@ -0,0 +1,4 @@
+module ActiveFlags
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/active_flags/application_mailer.rb

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

data/app/models/active_flags/application_record.rb

@@ -0,0 +1,5 @@
+module ActiveFlags
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/active_flags/flag.rb

@@ -0,0 +1,8 @@
+module ActiveFlags
+  class Flag < ApplicationRecord
+    belongs_to :subject, polymorphic: true
+
+    validates :subject, :key, :value, presence: true
+    validates :key, uniqueness: { scope: :subject }
+  end
+end

data/app/views/layouts/active_flags/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Active flags</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "active_flags/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+ActiveFlags::Engine.routes.draw do
+end

data/db/migrate/20190304151043_create_active_flags_flags.rb

@@ -0,0 +1,12 @@
+class CreateActiveFlagsFlags < ActiveRecord::Migration[6.0]
+  def change
+    create_table :active_flags_flags do |t|
+      t.string :key
+      t.string :value
+      t.integer :subject_id
+      t.string :subject_type
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20190305091129_add_indexes_on_subject_id_and_type.rb

@@ -0,0 +1,5 @@
+class AddIndexesOnSubjectIdAndType < ActiveRecord::Migration[6.0]
+  def change
+    add_index :active_flags_flags, [:subject_id, :subject_type]
+  end
+end

data/lib/active_flags/engine.rb

@@ -0,0 +1,10 @@
+# require_relative 'flaggable'
+
+module ActiveFlags
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveFlags
+    config.to_prepare do
+      ActiveRecord::Base.include ActiveFlags
+    end
+  end
+end

data/lib/active_flags/handler/flag_builder.rb

@@ -0,0 +1,16 @@
+module ActiveFlags
+  module Handler
+    class FlagBuilder
+      def initialize(resource, flag_attributes)
+        @resource = resource
+        @flag_attributes = flag_attributes
+      end
+
+      def save
+        @resource.flags << ActiveFlags::Flag.find_or_initialize_by(subject: @resource, key: @flag_attributes[:key]) do |flag_to_create|
+          flag_to_create.value = @flag_attributes[:value]
+        end
+      end
+    end
+  end
+end

data/lib/active_flags/handler/flag_mapper.rb

@@ -0,0 +1,22 @@
+require_relative 'flag_mappers/key_value_mapper'
+require_relative 'flag_mappers/authorizer'
+
+module ActiveFlags
+  module Handler
+    class FlagMapper
+      def initialize(authorized_flags = {}, flags)
+        @authorized_flags = authorized_flags
+        @flags = flags
+      end
+
+      def remap
+        @flags = FlagMappers::Authorizer.authorize(@authorized_flags, @flags)
+        FlagMappers::KeyValueMapper.remap(@flags)
+      end
+
+      def self.remap(authorized_flags, flags)
+        new(authorized_flags, flags).remap
+      end
+    end
+  end
+end

data/lib/active_flags/handler/flag_mappers/authorizer.rb

@@ -0,0 +1,23 @@
+module ActiveFlags
+  module Handler
+    module FlagMappers
+      class Authorizer
+        def initialize(authorized_flags = {}, flags)
+          @authorized_flags = authorized_flags
+          @flags = flags
+        end
+
+        def authorize
+          return @flags if @authorized_flags.empty?
+          @flags.select do |flag_name, value|
+            @authorized_flags.include?(flag_name)
+          end
+        end
+
+        def self.authorize(authorized_flags, flags)
+          new(authorized_flags, flags).authorize
+        end
+      end
+    end
+  end
+end

data/lib/active_flags/handler/flag_mappers/key_value_mapper.rb

@@ -0,0 +1,22 @@
+module ActiveFlags
+  module Handler
+    module FlagMappers
+      class KeyValueMapper
+
+        def initialize(hash_to_map)
+          @hash_to_map = hash_to_map
+        end
+
+        def remap
+          @hash_to_map.map do |key, value|
+            { key: key, value: value }
+          end
+        end
+
+        def self.remap(hash_of_flags)
+          new(hash_of_flags).remap
+        end
+      end
+    end
+  end
+end

data/lib/active_flags/version.rb

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

data/lib/active_flags.rb

@@ -0,0 +1,19 @@
+require "active_flags/engine"
+require_relative 'active_flags/handler/flag_mapper'
+require_relative 'active_flags/handler/flag_builder'
+
+module ActiveFlags
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def has_flags(*authorized_flags)
+      has_many :flags, class_name: 'ActiveFlags::Flag', as: :subject
+
+      define_method(:flags=) do |flags|
+        Handler::FlagMapper.remap(authorized_flags, flags.symbolize_keys).each do |flag_attributes|
+          Handler::FlagBuilder.new(self, flag_attributes).save
+        end
+      end
+    end
+  end
+end

data/lib/tasks/active_flags_tasks.rake

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: active_flags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Huberty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+description: Easily declare flags for your models.
+email:
+- nathan.huberty@orange.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/active_flags_manifest.js
+- app/assets/stylesheets/active_flags/application.css
+- app/controllers/active_flags/application_controller.rb
+- app/helpers/active_flags/application_helper.rb
+- app/jobs/active_flags/application_job.rb
+- app/mailers/active_flags/application_mailer.rb
+- app/models/active_flags/application_record.rb
+- app/models/active_flags/flag.rb
+- app/views/layouts/active_flags/application.html.erb
+- config/routes.rb
+- db/migrate/20190304151043_create_active_flags_flags.rb
+- db/migrate/20190305091129_add_indexes_on_subject_id_and_type.rb
+- lib/active_flags.rb
+- lib/active_flags/engine.rb
+- lib/active_flags/handler/flag_builder.rb
+- lib/active_flags/handler/flag_mapper.rb
+- lib/active_flags/handler/flag_mappers/authorizer.rb
+- lib/active_flags/handler/flag_mappers/key_value_mapper.rb
+- lib/active_flags/version.rb
+- lib/tasks/active_flags_tasks.rake
+homepage: https://github.com/FidMe/active_flags
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Easily declare flags for your models.
+test_files: []