sail 3.2.4 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40fb8e4bc4918c09d226baa2e97666dc61cf6734967538bb62f61d12391c5024
-  data.tar.gz: 53903455199dbf9fd1d310c50dd538856880cb2a740e11576c929609312099ae
+  metadata.gz: 05fca866e54ba0e38f8d78010f0cbe328b694b7f09619b36a2d533d3c5ed8f92
+  data.tar.gz: 9f95a6750ae40d4086d46fa56ff75323532ffd72cf109ee6a6425589d2220f4e
 SHA512:
-  metadata.gz: bb1365f1162a6b41ef8a57cc54b15f25e37dfa4dde08eb1a556dde193f0bf33600740c72f4e69e652ca4a2c6666bedc564d15af320f010cde018a73cf0d530c4
-  data.tar.gz: 6002b3b8f33133fd9b0181b9cc52b174e3533f9e28aa493a70ab52194415e44877f017a003a3488641cd673b20d06fce4ca7c8bb04db2be9288a4c5f7ececa39
+  metadata.gz: bfb372c20ab721d43af3f0d692ba0b1f5ff7d1c9185a4fe7a997c4e966589b1892b8027fecfed329328dce602f17516b3280030c39a67cf5a4de1c21135d3f0b
+  data.tar.gz: 0f238303cd0b2797649996dcf26b1df9a3299f34cc9fb987edf7fa71336ce2bee21bca2c7d416598b208bb87da8c0d45e1784a355e9612d0e1d1cd0960d19bfc

data/README.md

@@ -1,6 +1,6 @@
 ![dashboard](https://raw.githubusercontent.com/vinistock/sail/master/app/assets/images/sail/sail.png)
 
-[![Maintainability](https://api.codeclimate.com/v1/badges/00ed468acd8b93f66478/maintainability)](https://codeclimate.com/github/vinistock/sail/maintainability) [![Build Status](https://travis-ci.org/vinistock/sail.svg?branch=master)](https://travis-ci.org/vinistock/sail) [![Test Coverage](https://codeclimate.com/github/vinistock/sail/badges/coverage.svg)](https://codeclimate.com/github/vinistock/sail/coverage) [![Gem Version](https://badge.fury.io/rb/sail.svg)](https://badge.fury.io/rb/sail) ![](http://ruby-gem-downloads-badge.herokuapp.com/sail?color=brightgreen&type=total) [![Mentioned in Awesome Ruby](https://awesome.re/mentioned-badge.svg)](https://github.com/markets/awesome-ruby)
+[![Build Status](https://github.com/vinistock/sail/workflows/Ruby%20on%20Rails/badge.svg?branch=master)](https://github.com/vinistock/sail/actions) [![codecov](https://codecov.io/gh/vinistock/sail/branch/master/graph/badge.svg)](https://codecov.io/gh/vinistock/sail) [![Gem Version](https://badge.fury.io/rb/sail.svg)](https://badge.fury.io/rb/sail) ![](http://ruby-gem-downloads-badge.herokuapp.com/sail?color=brightgreen&type=total) [![Mentioned in Awesome Ruby](https://awesome.re/mentioned-badge.svg)](https://github.com/markets/awesome-ruby)
 
 # Sail
 
@@ -139,10 +139,10 @@ All possible cast types as well as detailed examples of usage can be found in th
 # Get setting value with appropriate cast type
 #
 # Returns setting value with cast or yields it if passed a block
-Sail.get("name")
+Sail.get(:name)
 
 # This usage will return the result of the block
-Sail.get("name") do |setting_value|
+Sail.get(:name) do |setting_value|
   my_code(setting_value)
 end
 
@@ -153,15 +153,15 @@ end
 
 # For example, this will ignore ExampleError, but any other error raised will increase
 # the count until the setting "name" is reset. 
-Sail.get("name", expected_errors: [ExampleError]) do |value|
+Sail.get(:name, expected_errors: [ExampleError]) do |value|
   code_that_can_raise_example_error(value) 
 end
 
 # Set setting value
-Sail.set("name", "value")
+Sail.set(:name, "value")
 
 # Reset setting value (requires the sail.yml file!)
-Sail.reset("name")
+Sail.reset(:name)
 
 # Switcher
 # This method will take three setting names as parameters
@@ -209,6 +209,47 @@ Response
 200 OK
 ```
 
+### GraphQL
+
+For GraphQL APIs, types and mutations are defined for convenience. Include Sail's Graphql modules to get the appropriate fields.
+
+```ruby
+# app/graphql/types/query_type.rb
+
+module Types
+  class QueryType < Types::BaseObject
+    include Sail::Graphql::Types
+  end
+end
+
+# app/graphql/types/mutation_type.rb
+
+module Types
+  class MutationType < Types::BaseObject
+    include Sail::Graphql::Mutations
+  end
+end
+```
+
+To query settings via GraphQL, use the following pattern.
+
+```graphql
+query {
+    sailGet(name: "my_setting")
+    sailSwitcher(positive: "positive_case_setting", negative: "negative_case_setting", throttledBy: "throttle_setting")
+}
+
+mutation {
+    sailSet(name: "my_setting", value: "value") {
+        success
+    }
+    
+    sailProfileSwitch(name: "my_profile") {
+        success
+    }
+}
+```
+
 ## Localization
 
 Sail's few strings are all localized for English in [en.yml], making it easy to create translations for the desired languages.

data/Rakefile

@@ -20,7 +20,7 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(spec: "app:db:test:prepare")
 task default: :spec
 
-task :all do
+task all: :environment do
   system("brakeman --no-pager && rake && rubocop --auto-correct && rails_best_practices")
 end
 

data/app/models/sail/setting.rb

@@ -11,7 +11,7 @@ module Sail
     class UnexpectedCastType < StandardError; end
 
     FULL_RANGE = (0...100).freeze
-    AVAILABLE_MODELS = Dir[Rails.root.join("app", "models", "*.rb")]
+    AVAILABLE_MODELS = Dir[Rails.root.join("app/models/*.rb")]
                        .map { |dir| dir.split("/").last.camelize.gsub(".rb", "") }.freeze
 
     has_many :entries, dependent: :destroy
@@ -32,11 +32,7 @@ module Sail
 
     after_initialize :instantiate_caster
 
-    scope :paginated, lambda { |page, per_page|
-      select(:name, :description, :group, :value, :cast_type, :updated_at)
-        .offset(page.to_i * per_page)
-        .limit(per_page)
-    }
+    scope :paginated, ->(page, per_page) { offset(page.to_i * per_page).limit(per_page) }
 
     scope :by_query, lambda { |query|
       if cast_types.key?(query) || query == Sail::ConstantCollection::STALE

data/app/views/sail/settings/index.html.erb

@@ -22,13 +22,23 @@
       <div class="clearfix"></div>
 
       <div class="page-links">
-        <%= link_to("", settings_path(page: [params[:page].to_i - 1, 0].max, monitor_mode: params[:monitor_mode]), method: :get, id: "angle-left-link", title: I18n.t("sail.previous_page")) %>
+        <%= link_to("", settings_path(page: [params[:page].to_i - 1, 0].max, monitor_mode: params[:monitor_mode], query: params[:query]), method: :get, id: "angle-left-link", title: I18n.t("sail.previous_page")) %>
+        <%= link_to(1, settings_path(page: 0, monitor_mode: params[:monitor_mode], query: params[:query]), method: :get, class: params[:page].to_i.zero? || params[:page].blank? ? "active" : "") %>
 
-        <% (0...@number_of_pages).each do |page| %>
-          <%= link_to(page + 1, settings_path(page: page, monitor_mode: params[:monitor_mode]), method: :get, class: params[:page].to_i == page || params[:page].blank? && page.zero? ? "active" : "") %>
+        <% if params[:page].to_i - Sail::ConstantCollection::MAX_PAGES > 1 %>
+          ●●●
         <% end %>
 
-        <%= link_to("", settings_path(page: [params[:page].to_i + 1, @number_of_pages - 1].min, monitor_mode: params[:monitor_mode]), method: :get, id: "angle-right-link", title: I18n.t("sail.next_page")) %>
+        <% ([params[:page].to_i - Sail::ConstantCollection::MAX_PAGES, 1].max...[@number_of_pages - 1, params[:page].to_i + Sail::ConstantCollection::MAX_PAGES].min).each do |page| %>
+          <%= link_to(page + 1, settings_path(page: page, monitor_mode: params[:monitor_mode], query: params[:query]), method: :get, class: params[:page].to_i == page || params[:page].blank? && page.zero? ? "active" : "") %>
+        <% end %>
+
+        <% if params[:page].to_i + Sail::ConstantCollection::MAX_PAGES < @number_of_pages - 1 %>
+          ●●●
+        <% end %>
+
+        <%= link_to(@number_of_pages, settings_path(page: @number_of_pages - 1, monitor_mode: params[:monitor_mode], query: params[:query]), method: :get, class: params[:page].to_i == @number_of_pages - 1 ? "active" : "") %>
+        <%= link_to("", settings_path(page: [params[:page].to_i + 1, @number_of_pages - 1].min, monitor_mode: params[:monitor_mode], query: params[:query]), method: :get, id: "angle-right-link", title: I18n.t("sail.next_page")) %>
       </div>
     </div>
   <% end %>

data/lib/sail.rb

@@ -9,6 +9,7 @@ module Sail # :nodoc:
   autoload :Configuration, "sail/configuration"
   autoload :Instrumenter, "sail/instrumenter"
   autoload :Types, "sail/types"
+  autoload :Graphql, "sail/graphql"
 
   class << self
     attr_writer :configuration

data/lib/sail/constant_collection.rb

@@ -20,5 +20,6 @@ module Sail
     SETTINGS_PER_PAGE = 8
     MINIMAL_SETTINGS_PER_PAGE = 24
     INPUT_DATE_FORMAT = "%Y-%m-%dT%H:%m:%S"
+    MAX_PAGES = 5
   end
 end

data/lib/sail/engine.rb

@@ -37,6 +37,12 @@ module Sail
     end
 
     config.after_initialize do
+      if Rails::VERSION::MAJOR < 5
+        warn(
+          "DEPRECATION WARNING: Sail will no longer support Rails versions < 5"
+        )
+      end
+
       errors = [ActiveRecord::NoDatabaseError]
       errors << PG::ConnectionBad if defined?(PG)
 

data/lib/sail/graphql.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Sail
+  # Graphql
+  #
+  # Module to include type definitions
+  # for GraphQL APIs.
+  module Graphql
+    autoload :Mutations, "sail/mutations"
+
+    module Types # :nodoc:
+      extend ActiveSupport::Concern
+
+      included do
+        field :sail_get, ::GraphQL::Types::JSON, null: true do
+          description "Returns the value for a given setting."
+          argument :name, String, required: true, description: "The setting's name."
+        end
+
+        field :sail_switcher, ::GraphQL::Types::JSON, null: true do
+          description "Switches between the positive or negative setting based on the throttle."
+          argument :positive, String, required: true, description: "The setting's name if the throttle is bigger than the desired amount."
+          argument :negative, String, required: true, description: "The setting's name if the throttle is smaller than the desired amount."
+          argument :throttled_by, String, required: true, description: "The throttle setting's name."
+        end
+
+        def sail_get(name:)
+          Sail.get(name)
+        end
+
+        def sail_switcher(positive:, negative:, throttled_by:)
+          Sail.switcher(
+            positive: positive,
+            negative: negative,
+            throttled_by: throttled_by
+          )
+        end
+      end
+    end
+  end
+end
+# :nocov:

data/lib/sail/mutations.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Sail
+  module Graphql
+    module Mutations # :nodoc:
+      extend ActiveSupport::Concern
+
+      included do
+        field :sail_set, mutation: SailSet do
+          description "Set the value for a setting."
+          argument :name, String, required: true
+          argument :value, String, required: true
+        end
+
+        field :sail_profile_switch, mutation: SailProfileSwitch do
+          description "Switches to the chosen profile."
+          argument :name, String, required: true
+        end
+      end
+
+      class SailSet < ::GraphQL::Schema::Mutation # :nodoc:
+        argument :name, String, required: true
+        argument :value, String, required: true
+
+        field :success, Boolean, null: false
+
+        def resolve(name:, value:)
+          _, success = Sail.set(name, value)
+          { success: success }
+        end
+      end
+
+      class SailProfileSwitch < ::GraphQL::Schema::Mutation # :nodoc:
+        argument :name, String, required: true
+
+        field :success, Boolean, null: false
+
+        def resolve(name:)
+          success = Profile.exists?(name: name)
+          Profile.switch(name)
+
+          { success: success }
+        end
+      end
+    end
+  end
+end
+# :nocov:

data/lib/sail/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sail
-  VERSION = "3.2.4"
+  VERSION = "3.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sail
 version: !ruby/object:Gem::Version
-  version: 3.2.4
+  version: 3.3.0
 platform: ruby
 authors:
 - Vinicius Stock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-02 00:00:00.000000000 Z
+date: 2019-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sassc-rails
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -375,7 +347,9 @@ files:
 - lib/sail/configuration.rb
 - lib/sail/constant_collection.rb
 - lib/sail/engine.rb
+- lib/sail/graphql.rb
 - lib/sail/instrumenter.rb
+- lib/sail/mutations.rb
 - lib/sail/railtie.rb
 - lib/sail/types.rb
 - lib/sail/types/ab_test.rb
@@ -402,7 +376,7 @@ licenses:
 metadata: {}
 post_install_message: |
   **************************************************************************
-  Sail 3.2.4!
+  Sail 3.3.0!
 
   For major version upgrades, check the CHANGELOG and run the updater to
   create necessary migrations.