pifano_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53b166a47b78898a520e8e9b6a146c3b1b748b650099dd4c4412308cdb87a8a5
+  data.tar.gz: f3b9aa3ee6a13a52fdbaa3f3944b005e5a663bbb57f953d3ff49b5f361bbfb3a
+SHA512:
+  metadata.gz: d32163c5e1339d4892e2b8e449e68ba87040b5cafe165931696cf658cb5f38823fb7b85e13a09040a9ad333e393487913ed9d69a57afbe6eb7da48e434531125
+  data.tar.gz: f7d5bc1bbdf572745c2a8a074a67e529e3aa2661b38b6ccac43dfb3016a9a243ba6b7adb53757b44516ff36bfc9a49f228db6bcb0ad395a79ece32ac7ee6cd8c

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2023-12-05
+
+### Added
+
+-   Initial release. Versioning will start at 0.1.0.
+
+### Changed
+
+### Removed
+
+### Fixed
+
+### Security

data/README.md

@@ -0,0 +1,92 @@
+# PifanoConfig
+
+This is a simple configurable gem that allows you to easily create a configuration file for your gem or application.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'pifano_config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+    
+    $ gem install pifano_config
+
+## Usage
+
+### Creating a configuration file
+
+To create a configuration file, you need to create a class and include the `PifanoConfig::Mixin` module.
+
+~~~ruby
+
+class MyAppConfig
+  include Pifano::Mixin
+  
+  # Define your configuration options here
+  config.on(:development) do |config|
+    # Define your configuration options for the development environment here
+    config[:my_option] = 'pifano dev'
+
+    # You can also define nested configurations
+    config[:database] = {
+        adapter: 'sqlite3',
+        database: 'db/development.sqlite3'
+    }
+  end
+
+  config.on(:production) do |config|
+    # Define your configuration options for the production environment here
+    config[:my_option] = 'pifano prod'
+    
+    # You can also define nested configurations
+    config[:database] = {
+        adapter: 'postgresql',
+        host: 'localhost',
+        database: 'my_app_production',
+        username: 'my_app',
+    }
+  end
+end
+~~~
+
+### Using a configuration file
+
+After creating your configuration class, you can use it to access your configuration options.
+
+~~~ruby
+# app/models/my_model.rb
+
+class MyModel
+  def self.adapter
+    MyAppConfig.config.environment(APP_ENV).database[:adapter]
+  end
+end
+
+MyModel.adapter
+# => 'sqlite3' or 'postgresql' depends on the APP_ENV value
+~~~
+
+### Setting the environment
+
+You can set the environment using the `APP_ENV` environment variable.
+
+~~~bash
+
+$ APP_ENV=development irb
+
+irb(main):001:0> MyApp.config.environment(APP_ENV).my_option
+=> 'pifano dev'
+
+irb(main):002:0> MyApp.config.environment(APP_ENV).database[:adapter]
+
+=> 'sqlite3'
+~~~
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aristotelesbr/pifano_config.

data/lib/pifano/config.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'pifano/option_builder'
+
+module Pifano
+  class Config
+    def initialize(builder: OptionBuilder.new)
+      @builder = builder
+      @options = {}
+    end
+
+    def on(env)
+      yield @builder if block_given?
+      @options[env] = @builder.build
+    end
+
+    def environment(env) = @options[env]
+  end
+
+  module Mixin
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def config
+        @config ||= Config.new
+      end
+    end
+  end
+end

data/lib/pifano/option_builder.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'pifano/option_factory'
+
+module Pifano
+  class OptionBuilder
+    attr_reader :config_hash
+
+    def initialize = @config_hash = {}
+
+    def []=(key, value)
+      @config_hash[key] = value
+    end
+
+    def build = OptionFactory.build(@config_hash)
+  end
+end

data/lib/pifano/option_factory.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'thread'
+
+module Pifano
+  module OptionFactory
+    @struct_cache = {}
+    @mutex = ::Mutex.new
+
+    def self.build(hash)
+      return unless hash.is_a?(::Hash)
+
+      struct_key = hash.keys.sort.join('_').to_sym
+      struct = get_or_create_struct(struct_key, hash.keys)
+
+      struct.new(hash)
+    end
+
+    def self.get_or_create_struct(struct_key, keys)
+      @mutex.synchronize do
+        @struct_cache[struct_key] ||= create_struct(keys)
+      end
+    end
+    private_class_method :get_or_create_struct
+
+    def self.create_struct(keys)
+      Struct.new(*keys, keyword_init: true) do
+        def initialize(hash)
+          hash.each do |k, v|
+            self[k] = v.is_a?(::Hash) ? OptionFactory.build(v) : v
+          end
+          freeze
+        end
+      end
+    end
+    private_class_method :create_struct
+  end
+end

data/lib/pifano_config/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PifanoConfig
+  VERSION = '0.1.0'
+end

data/lib/pifano_config.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'pifano_config/version'
+
+require 'pifano/config'

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: pifano_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aristóteles Coutinho
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-10 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Create simple configurations for your project by environment like playing a Pífano.
+      The Pífano is a traditional musical instrument of the Brazilian Northeast, made of wood and leather. It is a kind of flute, with a sharp and piercing sound. It is used in the forró, a typical dance of the region.
+email:
+- aristotelesbr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/pifano/config.rb
+- lib/pifano/option_builder.rb
+- lib/pifano/option_factory.rb
+- lib/pifano_config.rb
+- lib/pifano_config/version.rb
+homepage: https://rubygems.org/gems/pifano_config
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/gems/pifano_config
+  homepage_uri: https://rubygems.org/gems/pifano_config
+  source_code_uri: https://github.com/aristotelesbr/pifano_config
+  changelog_uri: https://github.com/aristotelesbr/pifano_config/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Simple configuration for your project by enviroment.
+test_files: []