pifano_config 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53b166a47b78898a520e8e9b6a146c3b1b748b650099dd4c4412308cdb87a8a5
-  data.tar.gz: f3b9aa3ee6a13a52fdbaa3f3944b005e5a663bbb57f953d3ff49b5f361bbfb3a
+  metadata.gz: 8389a6716f4d2a09bf392dd77755023ae24b08785a132686d03dfd90c2ac339a
+  data.tar.gz: 6d165e8f16da592041d33877f8ea1dcd573f2a1cc427b64ed36bc80b6926d2c0
 SHA512:
-  metadata.gz: d32163c5e1339d4892e2b8e449e68ba87040b5cafe165931696cf658cb5f38823fb7b85e13a09040a9ad333e393487913ed9d69a57afbe6eb7da48e434531125
-  data.tar.gz: f7d5bc1bbdf572745c2a8a074a67e529e3aa2661b38b6ccac43dfb3016a9a243ba6b7adb53757b44516ff36bfc9a49f228db6bcb0ad395a79ece32ac7ee6cd8c
+  metadata.gz: d5fc333691f0ae8f8f5314f5255c0a9edc7539c6db8b7f56ed0f1d5b772d646af9e682b122a1091466121f5efa854532c9a3a8be4ea47d831dcc02e78dc269b0
+  data.tar.gz: b07a4508e21ac677c6f9cb102dd51993da118ead8199b66c509497cb2575acfdd803aca3f52466b31bfa58fe41d9e9cdea0bab65873a755b32d55a7ac08ecd93

data/changelog.md

@@ -0,0 +1,47 @@
+# 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.2.0] - 2024-01-22
+
+### Added
+
+- Added simple getters for configuration values. Now you can get the value of a configuration key by calling `[]`. Ex. 
+
+```rb
+@config.evironment(:dev)[:option]
+
+# => "value"
+```
+
+- Added return values for `#environment` method. Now you can get the current values of the environment by calling `#environment` without any arguments. Ex.
+
+```rb
+@config.environment(:dev)
+
+# => { option1: "value1", option2: "value2" }
+```
+
+## Removed
+
+- Remove `OptionBuilder` class. It was not needed.
+- Remove `OptionFactory` class. It was not needed.
+
+## [0.1.0] - 2023-12-05
+
+### Added
+
+-   Initial release. Versioning will start at 0.1.0.
+
+### Changed
+
+### Removed
+
+### Fixed
+
+### Security

data/lib/pifano/config.rb

@@ -1,31 +1,99 @@
 # frozen_string_literal: true
 
-require 'pifano/option_builder'
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
 
 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
+	# This class is used to set the options for a specific environment.
+	#
+	# @public Since `stable-v1`.
+	#
+	class Config
+		# @!attribute [r] options
+		#   @returns [Hash] The options.
+		attr_reader :options
+
+		# @!attribute [r] env
+		#   @returns [Symbol] The environment.
+		attr_reader :env
+
+		# Initialize the configuration.
+		#
+		def initialize
+			@options = {}
+			@env = nil
+		end
+
+		# Set the options for a specific environment.
+		#
+		# @parameter env [Symbol] The environment to set the options.
+		# @yields {...} When a block is given, the block is yielded with the option.
+		#
+		def on(env)
+			raise ArgumentError, 'Block is required.' unless block_given?
+
+			@env = env
+			yield self
+			@env = nil
+		end
+
+		# Get the options for a specific environment.
+		#
+		# @parameter env_name [Symbol] The environment to get the options.
+		# @yields {...} When a block is given, the block is yielded with the option.
+		#
+		# @returns [Hash] The options.
+		#
+		def environment(env_name)
+			return {} unless @options.key?(env_name)
+
+			@env = env_name
+			yield self if block_given?
+			@env = nil
+			@options[env_name]
+		end
+
+		# Set the option for a specific environment.
+		#
+		# @parameter key [Symbol] The option name.
+		# @parameter value [String] The option value.
+		#
+		# @returns [Nil] The option value.
+		#
+		def []=(key, value)
+			@options[@env] ||= {}
+			@options[@env][key] = value
+		end
+
+		# Get the option for a specific environment.
+
+		# @parameter env [Symbol] The environment to get the option.
+		# @parameter key [Symbol] The option name.
+		#
+		# @returns [String] The option value.
+		#
+		def [](env, key) = @options[env][key]
+	end
+
+	# This module is used to include the `config` method in the class.
+	#
+	# @public Since `stable-v1`.
+	#
+	module Mixin
+		def self.included(klass)
+			klass.extend(ClassMethods)
+		end
+
+		# Extend the class methods.
+		#
+		module ClassMethods
+			# Get the configuration.
+			#
+			# @returns [Config] The configuration.
+			#
+			def config
+				@config ||= Config.new
+			end
+		end
+	end
 end

data/lib/pifano_config/version.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 module PifanoConfig
-  VERSION = '0.1.0'
+	VERSION = '0.2.0'
 end

data/lib/pifano_config.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 require_relative 'pifano_config/version'
 
 require 'pifano/config'

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2023, by Aristóteles Coutinho.  
+
+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,31 @@
+# Pifano::Config
+
+This is a simple configurable gem that allows you to easily create a configuration file for your gem or application.
+
+<p align="center">
+    <img src="pifano_config.jpeg" width="400" height="400" />
+</p>
+
+# Usage
+
+Please see the [project documentation](https://aristotelesbr.github.io/pifano_config/index.html) for more details.
+
+  - [Getting Started](https://aristotelesbr.github.io/pifano_config/guides/getting-started/index.html) - This guide show you how to use the `pífano config`.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,40 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: pifano_config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aristóteles Coutinho
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-12-10 00:00:00.000000000 Z
+date: 2024-01-22 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.
+description:
 email:
-- aristotelesbr@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- README.md
+- changelog.md
 - lib/pifano/config.rb
-- lib/pifano/option_builder.rb
-- lib/pifano/option_factory.rb
 - lib/pifano_config.rb
 - lib/pifano_config/version.rb
+- license.md
+- readme.md
 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
+  homepage_uri: https://rubygems.org/gems/pifano_config
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/aristotelesbr/pifano_config
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -43,14 +39,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Simple configuration for your project by enviroment.

data/CHANGELOG.md

@@ -1,22 +0,0 @@
-# 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

@@ -1,92 +0,0 @@
-# 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/option_builder.rb

@@ -1,17 +0,0 @@
-# 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

@@ -1,38 +0,0 @@
-# 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