featureomatic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc4d45fbd7dcbdadf66e3b333bb2f104364607c664b4bd446f68be29ed900210
+  data.tar.gz: 6c5fb6b3560bf4fc8511f46d814986ffeead205a5a4becfd7f4af7c0f198c3fc
+SHA512:
+  metadata.gz: 20dc8a1b115ca6edd1640793a001e93869519c8e4a74814803b8d2540f52b80528c1b18bff466048af0d1ba3acad253bdf5e0728c6b4e31992d1fd0a556d197a
+  data.tar.gz: e8396ecc9e32f83769c49478a60218d938b4eeac21c2981f03d2bc9e8f4fac5f0fd15f484c552431272c5167368d81cac6cec61497cc88858e882b7942991609

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Brad Gessler
+
+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,72 @@
+# Featureomatic
+
+Features are simple boolean flags that say whether or not they're enabled, right? RIGHT!? WRONG! Features can get quite complicated.
+
+This gem makes reasoning through those complexities much more sane by isolating them all into the `app/features` folder as plain 'ol Ruby objects (POROS), that way your team can reason through the features available in an app much better, test them, and do really complicated stuff when needed.
+
+# Use cases
+
+Here's why you'd want to use Featureomatic:
+
+## Turbo app built by a solopreneur deployed to the Apple App Store
+
+If you're deploying a simple Rails Turbo application to the web you might have 20 features that are available for purchase, but when deployed to the Apple App Store, you have to disable certain parts of your website to comply with their draconian app store policies. Featureomatic could disable the features that upset Apple, like links to your support and pricing, so that your app can get approved and stay in compliance.
+
+## B2B Rails app built by a 50 person engineering team for multinational enterprises
+
+Enterprise use-cases are even more complicated. If a package is sold to a multi-national customer with 200 features, they may want to disable 30 of those features for certain teams/groups within that organization for compliance reasons. You end up with a hierarchy that can get as complicated as, "The Zig Bang feature is available to MegaCorp on the Platimum plan, but only for their US entities if their team administrators turn that feature on because of weird compliance reasons".
+
+## Installation
+
+Install the gem by executing the following from your Rails root:
+
+```bash
+$ bundle add featureomatic
+```
+
+Then run
+
+```bash
+$ rails generate featureomatic:install
+```
+
+Restart your server and it's off to the races!
+
+First thing you'll want to checkout is the `./app/features/application_feature.rb` file:
+
+```ruby
+class ApplicationFeature < Featureomatic::Base
+  attr_reader :user
+
+  def initialize(user)
+    @user = user
+  end
+
+  def enabled?
+    user.paid?
+  end
+end
+```
+
+## Usage
+
+Ready to add a new feature? Sweet! Just run this:
+
+```bash
+$ rails generate featureomatic:new ModerationFeature
+```
+
+This creates the following file:
+
+```ruby
+# ./app/features/my_kewl_feature.rb
+class ModerationFeature < ApplicationFeature
+  def name
+    "Moderation"
+  end
+end
+```
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/featureomatic_manifest.js

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

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

@@ -0,0 +1,4 @@
+module Featureomatic
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/featureomatic/application_helper.rb

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

data/app/jobs/featureomatic/application_job.rb

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

data/app/mailers/featureomatic/application_mailer.rb

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

data/app/models/featureomatic/application_record.rb

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

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

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

data/config/routes.rb

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

data/lib/featureomatic/engine.rb

@@ -0,0 +1,5 @@
+module Featureomatic
+  class Engine < ::Rails::Engine
+    isolate_namespace Featureomatic
+  end
+end

data/lib/featureomatic/version.rb

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

data/lib/featureomatic.rb

@@ -0,0 +1,5 @@
+require "featureomatic/version"
+require "featureomatic/engine"
+
+module Featureomatic
+end

data/lib/tasks/featureomatic_tasks.rake

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

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: featureomatic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brad Gessler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.3
+description: Features can get really complicated when you have to cascade them from
+  global, account, policy, group, and policy levels. Featureomatic makes that easy!
+email:
+- bradgessler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/featureomatic_manifest.js
+- app/assets/stylesheets/featureomatic/application.css
+- app/controllers/featureomatic/application_controller.rb
+- app/helpers/featureomatic/application_helper.rb
+- app/jobs/featureomatic/application_job.rb
+- app/mailers/featureomatic/application_mailer.rb
+- app/models/featureomatic/application_record.rb
+- app/views/layouts/featureomatic/application.html.erb
+- config/routes.rb
+- lib/featureomatic.rb
+- lib/featureomatic/engine.rb
+- lib/featureomatic/version.rb
+- lib/tasks/featureomatic_tasks.rake
+homepage: https://github.com/rocketshipio/featureomatic
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rocketshipio/featureomatic
+  source_code_uri: https://github.com/rocketshipio/featureomatic
+  changelog_uri: https://github.com/rocketshipio/featureomatic
+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.3.15
+signing_key:
+specification_version: 4
+summary: Powerful cascading feature flags in Rails.
+test_files: []