tzispa_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7c13e7064f43f5e43dc54ea4f6918984ca24ea76dd9f2aa92c34feb77c03cb8
+  data.tar.gz: 1186683931e28684ffe50310d82e8d51ca08451405dfa66d39254da7599329e1
+SHA512:
+  metadata.gz: cb21bc2a1f00123de0f2ff6628e56b57d65e516d6d4e00d465adc289446f7d6dd997a7154860cd03961500c9a2480ae0f8ff6343d50bd6bdd9969cc9711602d3
+  data.tar.gz: 2fc291a12d5812aca417a5d9ab3c50145ba8774e72566349126aabbdf9f38cf8072582587ee31be5158c73d0084865454d749d91157ca4a6223054ac2daf9826

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+Tzispa Annotations
+
+## v0.1.0
+- Initial version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at japinero@area-integral.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Juan Antonio Piñero
+
+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,43 @@
+# Tzispa::Config
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tzispa_config`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tzispa_config'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tzispa_config
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tzispa_config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TzispaAnnotation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tzispa_config/blob/master/CODE_OF_CONDUCT.md).

data/lib/tzispa/config.rb

@@ -0,0 +1,8 @@
+module Tzispa
+  module Config
+
+    autoload :Base,  'tzispa/config/base'
+    autoload :Yaml,  'tzispa/config/yaml'
+
+  end
+end

data/lib/tzispa/config/base.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module Tzispa
+  module Config
+
+    class Base < Struct
+      def self.parametrize(params)
+        new(*params&.keys&.map(&:to_sym)).new(*(params&.values&.map do |v|
+          v.is_a?(Hash) ? parametrize(v) : v
+        end))
+      end
+
+      def method_missing(m, *args, &block)
+        return if respond_to_missing?(m)
+        super
+      end
+
+      def respond_to_missing?(_sym, _include_priv)
+        true
+      end
+    end
+
+  end
+end

data/lib/tzispa/config/environment.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Tzispa
+  module Config
+    module Environment
+
+      RACK_ENV = 'RACK_ENV'
+
+      TZISPA_ENV = 'TZISPA_ENV'
+
+      DEVELOPMENT_ENV = 'development'
+
+      DEFAULT_ENV = 'development'
+
+      PRODUCTION_ENV = 'deployment'
+
+      RACK_ENV_DEPLOYMENT = 'deployment'
+
+      DEFAULT_DOTENV_ENV = '.env.%s'
+
+      DEFAULT_CONFIG = 'config'
+
+      TZISPA_HOST = 'TZISPA_HOST'
+
+      TZISPA_SSL = 'TZISPA_SSL'
+
+      TZISPA_SERVER_HOST = 'TZISPA_SERVER_HOST'
+
+      DEFAULT_HOST = 'localhost'
+
+      TZISPA_PORT = 'TZISPA_PORT'
+
+      TZISPA_SERVER_PORT = 'TZISPA_SERVER_PORT'
+
+      DEFAULT_PORT = 9412
+
+      DEFAULT_RACKUP = 'tzispa.ru'
+
+      DEFAULT_ENVIRONMENT_CONFIG = 'environment'
+
+      DEFAULT_DOMAINS_PATH = 'apps'
+
+      DOMAINS = 'domains'
+
+      DOMAINS_PATH = 'apps/%s'
+
+      APPLICATION = 'application'
+
+      APPLICATION_PATH = 'app'
+
+    end
+  end
+end

data/lib/tzispa/config/rc.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Tzispa
+  module Config
+    module Rc
+
+      DEFAULT_ARCHITECTURE = 'domains'
+
+      APP_ARCHITECTURE = 'app'
+
+      ARCHITECTURE_KEY = 'architecture'
+
+      PROJECT_NAME = 'project'
+
+      DEFAULT_TEST_SUITE = 'minitest'
+
+      TEST_KEY = 'test'
+
+    end
+  end
+end

data/lib/tzispa/config/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tzispa
+  module Config
+    VERSION = '0.1.0'
+  end
+end

data/lib/tzispa/config/yaml.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'tzispa/config/base'
+
+module Tzispa
+  module Config
+
+    class Yaml < Tzispa::Config::Base
+      def self.load(filename)
+        params = YAML.safe_load(File.open(filename))
+        parametrize params
+      end
+
+      def self.save(cfg, filename)
+        File.open(filename, 'w') do |f|
+          f.write cfg.to_yaml
+        end
+      end
+    end
+
+  end
+end

data/lib/tzispa/env.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'dotenv'
+
+module Tzispa
+
+  class Env
+    def initialize(env: ENV)
+      @env = env
+    end
+
+    def [](key)
+      @env[key]
+    end
+
+    def []=(key, value)
+      @env[key] = value
+    end
+
+    def key?(key)
+      @env.key? key
+    end
+
+    def load!(path)
+      return unless defined?(Dotenv)
+
+      contents = ::File.open(path, 'rb:bom|utf-8', &:read)
+      parsed   = Dotenv::Parser.call(contents)
+
+      parsed.each do |k, v|
+        next if @env.key?(k)
+        @env[k] = v
+      end
+      nil
+    end
+  end
+
+end

data/lib/tzispa/environment.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'singleton'
+require 'tzispa/env'
+require 'tzispa/tzisparc'
+require 'tzispa_utils'
+require 'tzispa/config/environment'
+
+module Tzispa
+
+  class Environment
+    include Singleton
+    include Tzispa::Config::Environment
+    using Tzispa::Utils::TzHash
+
+    LOCK = Mutex.new
+
+    # rubocop:disable Style/ClassVars
+    @@opts = {}
+
+    def initialize
+      @env     = Tzispa::Env.new(env: @@opts.delete(:env) || ENV)
+      @options = Tzispa::Tzisparc.new(root).options
+      @options.merge! @@opts.clone.symbolize!
+      LOCK.synchronize { set_env_vars! }
+    end
+
+    class << self
+      def opts=(hash)
+        @@opts = hash.to_h.dup
+      end
+
+      def [](key)
+        instance[key]
+      end
+
+      def method_missing(name, *args, &block)
+        if instance.respond_to? name
+          instance.send name, *args, &block
+        elsif instance.key? ekup = name.to_s.upcase
+          instance[ekup]
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(name, _include_priv)
+        instance.respond_to?(name) || instance.key?(name.to_s.upcase)
+      end
+    end
+    # rubocop:enable Style/ClassVars
+
+    def [](key)
+      @env[key]
+    end
+
+    def key?(key)
+      @env.key? key
+    end
+
+    def environment
+      @environment ||= env[TZISPA_ENV] || rack_env || DEFAULT_ENV
+    end
+
+    def development?
+      environment == DEVELOPMENT_ENV
+    end
+
+    def code_reloading?
+      development?
+    end
+
+    def environment?(*names)
+      names.map(&:to_s).include?(environment)
+    end
+
+    def bundler_groups
+      [:default, environment.to_sym]
+    end
+
+    def root
+      @root ||= Pathname.new(Dir.pwd)
+    end
+
+    def config
+      @config ||= root.join(@options.fetch(:config) { DEFAULT_CONFIG })
+    end
+
+    def project_name
+      @options.fetch(:project)
+    end
+
+    def architecture
+      @options.fetch(:architecture) do
+        warn "Tzispa architecture unknown: see `.tzisparc'"
+        exit 1
+      end
+    end
+
+    def apps_path
+      @options.fetch(:path) do
+        case architecture
+        when DOMAINS
+          DOMAINS_PATH
+        when APPLICATION
+          APPLICATION_PATH
+        end
+      end
+    end
+
+    def host
+      @host ||= @options.fetch(:host) do
+        env[TZISPA_HOST] || DEFAULT_HOST
+      end
+    end
+
+    def server_host
+      @server_host ||= @options.fetch(:server_host) do
+        env[TZISPA_SERVER_HOST] || host
+      end
+    end
+
+    def port
+      @port ||= @options.fetch(:port) do
+        env[TZISPA_PORT] || DEFAULT_PORT
+      end.to_i
+    end
+
+    def server_port
+      @server_port ||= @options.fetch(:server_port) do
+        env[TZISPA_SERVER_PORT] || port
+      end.to_i
+    end
+
+    def uri_port
+      if ssl?
+        ":#{port}" unless port == 443
+      else
+        ":#{port}" unless port == 80
+      end
+    end
+
+    def domains_path
+      @domains_path ||= @options.fetch(:domains_path) do
+        env[DOMAINS_PATH] || DEFAULT_DOMAINS_PATH
+      end
+    end
+
+    def default_port?
+      port == DEFAULT_PORT
+    end
+
+    def ssl?
+      env[TZISPA_SSL] == 'yes'
+    end
+
+    def rackup
+      root.join(@options.fetch(:rackup) { DEFAULT_RACKUP })
+    end
+
+    def daemonize?
+      @options.key?(:daemonize) && @options.fetch(:daemonize)
+    end
+
+    def to_options
+      @options.to_h.merge(
+        environment: environment,
+        apps_path:   apps_path,
+        rackup:      rackup,
+        host:        server_host,
+        port:        server_port
+      )
+    end
+
+    private
+
+    attr_reader :env
+
+    def set_env_vars!
+      set_application_env_vars!
+      set_tzispa_env_vars!
+    end
+
+    def set_tzispa_env_vars!
+      env[TZISPA_ENV]  = env[RACK_ENV] = environment
+      env[TZISPA_HOST] = host
+      env[TZISPA_PORT] = port.to_s
+    end
+
+    def set_application_env_vars!
+      dotenv = root.join(DEFAULT_DOTENV_ENV % environment)
+      env.load!(dotenv) if dotenv.exist?
+    end
+
+    def rack_env
+      case env[RACK_ENV]
+      when RACK_ENV_DEPLOYMENT
+        PRODUCTION_ENV
+      else
+        env[RACK_ENV]
+      end
+    end
+  end
+end

data/lib/tzispa/tzisparc.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'tzispa_utils'
+require 'tzispa/config/rc'
+
+module Tzispa
+
+  class Tzisparc
+    using Tzispa::Utils::TzHash
+
+    include Tzispa::Config::Rc
+
+    FILE_NAME = '.tzisparc'
+
+    SEPARATOR = '='
+
+    def initialize(root)
+      @root = root
+    end
+
+    def options
+      @options ||= default_options.merge(file_options).symbolize!
+    end
+
+    def default_options
+      @default_options ||= { ARCHITECTURE_KEY => DEFAULT_ARCHITECTURE,
+                             PROJECT_NAME     => project_name,
+                             TEST_KEY         => DEFAULT_TEST_SUITE }
+    end
+
+    def exists?
+      path_file.exist?
+    end
+
+    def generate
+      File.open(path_file, 'w') do |file|
+        default_options.each { |k, v| file.puts("#{k}#{SEPARATOR}#{v}") }
+      end
+    end
+
+    private
+
+    def file_options
+      exists? ? parse_file(path_file) : {}
+    end
+
+    def parse_file(path)
+      {}.tap do |hash|
+        File.readlines(path).each do |line|
+          key, value = line.split(SEPARATOR)
+          hash[key] = value.strip
+        end
+      end
+    end
+
+    def path_file
+      @root.join FILE_NAME
+    end
+
+    def project_name
+      ::File.basename(@root)
+    end
+  end
+
+end

data/lib/tzispa_config.rb

@@ -0,0 +1,11 @@
+module Tzispa
+
+  autoload :Environment, 'tzispa/environment'
+  
+  module Config
+
+    require 'tzispa/config/version'
+    require 'tzispa/config'
+
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: tzispa_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Antonio Piñero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzispa_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- japinero@area-integral.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/tzispa/config.rb
+- lib/tzispa/config/base.rb
+- lib/tzispa/config/environment.rb
+- lib/tzispa/config/rc.rb
+- lib/tzispa/config/version.rb
+- lib/tzispa/config/yaml.rb
+- lib/tzispa/env.rb
+- lib/tzispa/environment.rb
+- lib/tzispa/tzisparc.rb
+- lib/tzispa_config.rb
+homepage: https://github.com/japiber/tzispa_config
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- test
+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.3
+signing_key: 
+specification_version: 4
+summary: configuration management
+test_files: []