easy-configuration 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8cfb090344f0ee119f47ffaa11bf4fd061394793094ee3b0d61811946df818ed
+  data.tar.gz: 02ee4eb7ebc80ff701b8ac7e5fc8020b8362de91529fc86cf5cd9f900d6901ab
+SHA512:
+  metadata.gz: c447a81ed756655a68d50d752a877a0a1e596e55fb9190bfac6a5febffd3dd6aded64f1e5059c7984d5de9da2ad186993ba59fe1c95ac9e3033c7a8796e357bd
+  data.tar.gz: 14a3f0d61048bca07ae7329665cba96ce4ce80ae0295cb15f882aef50081531a77e52d0194c05760d344aded8e59bd8253b11df867837cd00b999ac0c4679edf

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 petr
+
+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,28 @@
+# Easy::Configuration
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy-configuration'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install easy-configuration
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,27 @@
+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    = 'Easy::Configuration'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+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/lib/easy/configuration.rb

@@ -0,0 +1,112 @@
+require "easy/configuration/railtie"
+
+module Easy
+  module Configuration
+    extend ActiveSupport::Autoload
+
+    autoload :Structure
+    autoload :Auth
+    autoload :Autocomplete
+    autoload :Custom
+    autoload :Entity
+    autoload :Menu
+    autoload :MenuItem
+    autoload :MenuTitle
+    autoload :MenuEntityLink
+    autoload :MenuCustomLink
+
+    module Patches
+      extend ActiveSupport::Autoload
+
+      autoload :ActiveRecord
+    end
+
+    cattr_accessor :application_name
+    self.application_name = 'Easy'
+
+    cattr_accessor :application_icon
+    self.application_icon = 'application_icon'
+
+    cattr_accessor :email_default_from
+    self.email_default_from = 'info@easysoftware.com'
+
+    cattr_accessor :protocol
+    self.protocol = 'https'
+
+    cattr_accessor :host_name
+    self.host_name = 'app.easysoftware.com'
+
+    cattr_accessor :_entities
+    self._entities = {}
+
+    cattr_accessor :_menu
+    self._menu = {}
+
+    class << self
+
+      def host
+        "#{protocol}://#{host_name}"
+      end
+
+      def entity(klass_or_name, &block)
+        k = klass_or_name.is_a?(String) ? klass_or_name : klass_or_name.name.underscore
+
+        self._entities[k] ||= Entity.new(k)
+
+        if block_given?
+          yield self._entities[k]
+        else
+          self._entities[k]
+        end
+      end
+
+      def menu(section, &block)
+        self._menu[section.to_s] ||= Menu.new
+
+        if block_given?
+          yield self._menu[section.to_s]
+        else
+          self._menu[section.to_s]
+        end
+      end
+
+      def auth(&block)
+        if block_given?
+          yield Auth
+        else
+          Auth
+        end
+      end
+
+      def sites
+        @sites ||= begin
+          h = ::ActiveSupport::OrderedOptions.new
+          h.merge!(secrets.sites || {})
+          h
+        end
+      end
+
+      def custom
+        @custom ||= Custom.new
+      end
+
+      def secrets
+        Rails.application.secrets
+      end
+
+    end
+
+  end
+
+  class << self
+
+    def config
+      ::Easy::Configuration
+    end
+
+    def configure
+      yield config
+    end
+
+  end
+end

data/lib/easy/configuration/auth.rb

@@ -0,0 +1,58 @@
+module Easy
+  module Configuration
+    module Auth
+
+      cattr_accessor :required
+      self.required = false
+
+      cattr_accessor :no_password_auth
+      self.no_password_auth = false
+
+      cattr_accessor :only_omniauth
+      self.only_omniauth = false
+
+      cattr_accessor :allow_anonymous_readonly_api
+      self.allow_anonymous_readonly_api = false
+
+      cattr_accessor :token_auth
+      self.token_auth = false
+
+      class << self
+
+        def required?
+          !!self.required
+        end
+
+        def no_password_auth?
+          !!self.no_password_auth
+        end
+
+        def token_auth?
+          !!self.token_auth
+        end
+
+        def allow_anonymous_readonly_api?
+          !!self.allow_anonymous_readonly_api
+        end
+
+        def only_omniauth?
+          !!self.only_omniauth
+        end
+
+        def omniauth_providers
+          Rails.application.secrets.omniauth_providers || {}
+        end
+
+        def omniauth_providers_keys
+          omniauth_providers.keys
+        end
+
+        def social_sign_in?
+          (%i(facebook google_oauth2 twitter linkedin) & omniauth_providers_keys).present?
+        end
+
+      end
+
+    end
+  end
+end

data/lib/easy/configuration/custom.rb

@@ -0,0 +1,35 @@
+module Easy
+  module Configuration
+    class Custom
+
+      def method_missing(name, *args)
+        name_string = name.to_s
+        if name_string.chomp!("=")
+          from_file[name_string] = args.first
+        else
+          bangs = name_string.chomp!("!")
+
+          if bangs
+            from_file[name_string].presence || raise(KeyError.new(":#{name_string} is blank"))
+          else
+            from_file[name_string]
+          end
+        end
+      end
+
+      def respond_to_missing?(name, include_private)
+        true
+      end
+
+      private
+
+      def from_file
+        @from_file ||= begin
+          file_path = Rails.root.join('config/config.yml')
+          File.exists?(file_path) ? YAML.load_file(file_path) : {}
+        end
+      end
+
+    end
+  end
+end

data/lib/easy/configuration/entity.rb

@@ -0,0 +1,27 @@
+module Easy
+  module Configuration
+    class Entity
+
+      attr_accessor :no_count
+
+      def initialize(klass_name)
+        @klass_name   = klass_name
+        @no_count     = false
+        @menu         = Hash.new { |hash, key| hash[key.to_s] = Menu.new }
+      end
+
+      def no_count?
+        !!no_count
+      end
+
+      def menu(section, &block)
+        if block_given?
+          yield @menu[section.to_s]
+        else
+          @menu[section.to_s]
+        end
+      end
+
+    end
+  end
+end

data/lib/easy/configuration/menu.rb

@@ -0,0 +1,69 @@
+module Easy
+  module Configuration
+    class Menu
+
+      attr_accessor :visibility
+      attr_writer :caption
+
+      def initialize
+        @items   = {}
+        @caption = nil
+      end
+
+      def visible?(current_user)
+        case @visibility
+        when Proc
+          @visibility.call(current_user)
+        when NilClass
+          true
+        else
+          !!@visibility
+        end
+      end
+
+      def caption
+        case @caption
+        when String
+          @caption
+        when NilClass
+          ''
+        else
+          I18n.t(@caption)
+        end
+      end
+
+      def custom_link(key, options = {}, &block)
+        parent = options.delete(:parent)
+
+        add(key, MenuCustomLink.new(options, &block), parent)
+      end
+
+      def entity_link(class_name, options = {}, &block)
+        parent = options.delete(:parent)
+
+        add(class_name, MenuEntityLink.new(class_name, options, &block), parent)
+      end
+
+      def title(key, options = {}, &block)
+        parent = options.delete(:parent)
+
+        add(key, MenuTitle.new(options, &block), parent)
+      end
+
+      def items
+        @items.values
+      end
+
+      private
+
+      def add(key, menu_item, parent = nil)
+        if parent && @items[parent.to_s]
+          @items[parent.to_s].children[key.to_s] = menu_item
+        else
+          @items[key.to_s] = menu_item
+        end
+      end
+
+    end
+  end
+end

data/lib/easy/configuration/menu_custom_link.rb

@@ -0,0 +1,33 @@
+module Easy
+  module Configuration
+    class MenuCustomLink < MenuTitle
+
+      attr_reader :icon
+
+      def initialize(options = {}, &block)
+        @url          = options.delete(:url)
+        @title        = options.delete(:title)
+        @icon         = options.delete(:icon)
+
+        super(options, &block)
+      end
+
+      def title
+        case @title
+        when String
+          @title
+        else
+          I18n.t(@title)
+        end
+      end
+
+      def url(view_context, decorator)
+        case @url
+        when Proc
+          @url.call(view_context, decorator)
+        end
+      end
+
+    end
+  end
+end

data/lib/easy/configuration/menu_entity_link.rb

@@ -0,0 +1,19 @@
+module Easy
+  module Configuration
+    class MenuEntityLink < MenuCustomLink
+
+      attr_reader :class_name
+
+      def initialize(class_name, options = {}, &block)
+        @class_name = class_name
+
+        super(options, &block)
+      end
+
+      def url(view_context, decorator)
+        super || decorator.path_to_index
+      end
+
+    end
+  end
+end

data/lib/easy/configuration/menu_item.rb

@@ -0,0 +1,32 @@
+module Easy
+  module Configuration
+    class MenuItem
+
+      attr_reader :children, :link_setup, :html_options
+
+      def initialize(options = {}, &block)
+        @visibility   = options.delete(:visibility)
+        @html_options = options.delete(:html) || {}
+        @options      = options
+        @link_setup   = block
+        @children     = {}
+      end
+
+      def children?
+        @children.present?
+      end
+
+      def visible?(current_user)
+        case @visibility
+        when Proc
+          @visibility.call(current_user)
+        when NilClass
+          true
+        else
+          !!@visibility
+        end
+      end
+
+    end
+  end
+end

data/lib/easy/configuration/menu_title.rb

@@ -0,0 +1,24 @@
+module Easy
+  module Configuration
+    class MenuTitle < MenuItem
+
+      def initialize(options = {}, &block)
+        @caption = options.delete(:caption)
+
+        super(options, &block)
+      end
+
+      def caption
+        case @caption
+        when String
+          @caption
+        when NilClass
+          ''
+        else
+          I18n.t(@caption)
+        end
+      end
+
+    end
+  end
+end

data/lib/easy/configuration/patches/active_record.rb

@@ -0,0 +1,18 @@
+module Easy
+  module Configuration
+    module Patches
+      module ActiveRecord
+        extend ActiveSupport::Concern
+
+        class_methods do
+
+          def config
+            Easy.config.entity(self)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/easy/configuration/railtie.rb

@@ -0,0 +1,11 @@
+module Easy
+  module Configuration
+    class Railtie < ::Rails::Railtie
+
+      config.to_prepare do
+        ::ActiveRecord::Base.include Patches::ActiveRecord
+      end
+
+    end
+  end
+end

data/lib/easy/configuration/structure.rb

@@ -0,0 +1,51 @@
+module Easy
+  module Configuration
+    class Structure
+
+      def initialize(default_values = {})
+        @values  = default_values.dup
+        @changed = Hash.new { |hash, key| hash[key] = false }
+
+        define_instance_methods
+      end
+
+      def merge!(structure, ignore_defaults = true)
+        if ignore_defaults
+          @values.merge!(structure.values) { |key, v1, v2| structure.changed?(key) ? v2 : v1 }
+        else
+          @values.merge!(structure.values)
+        end
+      end
+
+      protected
+
+      def values
+        @values
+      end
+
+      def changed?(attribute)
+        @changed[attribute]
+      end
+
+      private
+
+      def define_instance_methods
+        @values.keys.each do |key|
+          self.class.send :define_method, key do
+            @values[key]
+          end
+
+          self.class.send :define_method, "#{key}_changed?" do
+            @changed[key]
+          end
+
+          self.class.send :define_method, "#{key}=" do |v|
+            @changed[key] = true
+            @values[key]  = v
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/easy/configuration/version.rb

@@ -0,0 +1,5 @@
+module Easy
+  module Configuration
+    VERSION = '0.5.1'
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: easy-configuration
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- petr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !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: Description of Easy::Configuration.
+email:
+- petr@easy.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/easy/configuration.rb
+- lib/easy/configuration/auth.rb
+- lib/easy/configuration/custom.rb
+- lib/easy/configuration/entity.rb
+- lib/easy/configuration/menu.rb
+- lib/easy/configuration/menu_custom_link.rb
+- lib/easy/configuration/menu_entity_link.rb
+- lib/easy/configuration/menu_item.rb
+- lib/easy/configuration/menu_title.rb
+- lib/easy/configuration/patches/active_record.rb
+- lib/easy/configuration/railtie.rb
+- lib/easy/configuration/structure.rb
+- lib/easy/configuration/version.rb
+homepage: https://www.easysoftware.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Summary of Easy::Configuration.
+test_files: []