unifig-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee97e3ee9ea7a7291cf9f7ade08f4094dda73d94f66b754212dd4b50da4809a6
+  data.tar.gz: 6836466d1255f6ff9e11a66e8441ce46a4230b1c61bd1dcfdf2a812c896ab40d
+SHA512:
+  metadata.gz: 0e7fb023670ab143c7e962afc5d8034b7c1b10f49e15f9a3c58b5958e449d1de7ae561ccf7ee255dc375757b08caf985e85d3061b01e5c3f62bced894061026f
+  data.tar.gz: a04837c002905ca81012bca00a85869796bba7d2e78ce37aa119113b4e5bb97cf63ed9a7df39d79c0ba0607c006b3bdd617c7a6250a9c22765565b43ea30151a

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# [0.1.0][] (2022-07-24)
+
+Initial release.
+
+[0.1.0]: https://github.com/AaronLasseigne/unifig/compare/v0.0.0...v0.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing
+
+For features please open a [discussion][] and we can make sure the feature fits with the gem before working on it.
+
+## Steps
+
+1. [Fork][] the repo.
+2. Add a breaking test for your change.
+3. Make the tests pass.
+4. Push your fork.
+5. Submit a pull request against the `next` branch.
+
+## Code Style
+
+Running the tests using `rake` (with no args) will also check for style issues in the code.
+If you have a failure you cannot figure out push the PR and ask for help.
+
+[fork]: https://github.com/AaronLasseigne/unifig-rails/fork
+[discussion]: https://github.com/AaronLasseigne/unifig-rails/discussions/categories/ideas

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Aaron Lasseigne
+
+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,48 @@
+# [Unifig::Rails][]
+
+Adds [Rails][] support to [Unifig][].
+
+[![Version](https://img.shields.io/gem/v/unifig-rails.svg?style=flat-square)](https://rubygems.org/gems/unifig-rails)
+[![Test](https://img.shields.io/github/workflow/status/AaronLasseigne/unifig-rails/Test?label=Test&style=flat-square)](https://github.com/AaronLasseigne/unifig-rails/actions?query=workflow%3ATest)
+
+## Installation
+
+Add it to your Gemfile:
+
+``` rb
+gem 'unifig-rails', '~> 0.1.0'
+```
+
+Run the configuration generator:
+
+``` sh
+rails generate unifig:config
+```
+
+This project uses [Semantic Versioning][].
+Check out [GitHub releases][] for a detailed list of changes.
+
+## Usage
+
+Once your Rails app has been started you will be able use Unifig with the setup you've created in `config/unifig.yml`.
+
+For information on how to use Unifig see the [documentation][] for that gem.
+
+## Contributing
+
+If you want to contribute to Unifig::Rails, please read [our contribution guidelines][].
+A [complete list of contributors][] is available on GitHub.
+
+## License
+
+Unifig is licensed under [the MIT License][].
+
+[Unifig::Rails]: https://github.com/AaronLasseigne/unifig-rails
+[Rails]: https://rubyonrails.org
+[Unifig]: https://github.com/AaronLasseigne/unifig
+[documentation]: https://github.com/AaronLasseigne/unifig#usage
+[Semantic Versioning]: http://semver.org/spec/v2.0.0.html
+[GitHub releases]: https://github.com/AaronLasseigne/unifig-rails/releases
+[our contribution guidelines]: CONTRIBUTING.md
+[complete list of contributors]: https://github.com/AaronLasseigne/unifig-rails/graphs/contributors
+[the MIT License]: LICENSE.txt

data/lib/generators/unifig/config_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Unifig
+  # @private
+  class ConfigGenerator < ::Rails::Generators::Base
+    desc 'Create a Unifig configuration file.'
+    def config
+      abort 'A configuration file already exists.' if File.exist?(Unifig::Rails::CONFIG_PATH)
+
+      create_file Unifig::Rails::CONFIG_PATH, <<~YML
+        config:
+          providers: local
+
+
+      YML
+    end
+  end
+end

data/lib/unifig/rails/version.rb

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

data/lib/unifig/rails.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+require 'unifig'
+
+require_relative 'railtie'
+require_relative 'rails/version'
+require_relative '../generators/unifig/config_generator'
+
+module Unifig
+  # @private
+  module Rails
+    # @private
+    CONFIG_PATH = File.join('config', 'unifig.yml')
+
+    def self.run
+      file_path = ::Rails.root.join(CONFIG_PATH)
+      Unifig::Init.load_file(file_path, env: ::Rails.env.to_sym) if File.exist?(file_path)
+    end
+  end
+end

data/lib/unifig/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Unifig
+  # @private
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do
+      Rails.run
+    end
+  end
+end

data/spec/generators/unifig/config_generator_spec.rb

@@ -0,0 +1,40 @@
+RSpec.describe Unifig::ConfigGenerator do
+  it 'adds a generator to Rails' do
+    expect(rails('generate')).to include 'unifig:config'
+  end
+
+  it 'writes the file out' do
+    rails('generate unifig:config')
+    content = in_rails do
+      File.read(Unifig::Rails::CONFIG_PATH)
+    end
+
+    expect(content).to eql <<~YML
+      config:
+        providers: local
+
+
+    YML
+  end
+
+  context 'with an existing file' do
+    before do
+      write_config(<<~YML)
+        config:
+          providers: local
+
+        ONE:
+          value: 1
+      YML
+    end
+
+    it 'fails' do
+      rails('generate unifig:config')
+      content = in_rails do
+        File.read(Unifig::Rails::CONFIG_PATH)
+      end
+
+      expect(content).to include 'ONE'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+require 'fileutils'
+require 'unifig/rails'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.on_potential_false_positives = :nothing
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.filter_run_when_matching :focus
+
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.before(:suite) do
+    Dir.mkdir('tmp') unless Dir.exist?('tmp')
+    cleanup
+
+    Dir.chdir('tmp') do
+      `bundle exec rails new example --minimal`
+      Dir.chdir('example') do
+        append_to_file('Gemfile', 'gem "unifig-rails", path: "../../"')
+        Bundler.with_unbundled_env do
+          `bundle install`
+        end
+      end
+    end
+  end
+
+  config.after(:suite) do
+    cleanup
+  end
+
+  config.after do
+    in_rails do
+      Dir.chdir('config') do
+        File.unlink('unifig.yml') if File.exist?('unifig.yml')
+      end
+    end
+  end
+end
+
+def cleanup
+  Dir.chdir('tmp') do
+    FileUtils.rm_rf('example') if Dir.exist?('example')
+  end
+end
+
+def append_to_file(file, addition)
+  File.write(file, "\n#{addition}", mode: 'a')
+end
+
+def in_rails(&block)
+  Dir.chdir('tmp') do
+    Dir.chdir('example', &block)
+  end
+end
+
+def write_config(yml)
+  in_rails do
+    Dir.chdir('config') do
+      File.write('unifig.yml', yml)
+    end
+  end
+end
+
+def rails(cmd)
+  in_rails do
+    Bundler.with_unbundled_env do
+      `bundle exec rails #{cmd}`
+    end
+  end
+end

data/spec/unifig/railtie_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RSpec.describe Unifig::Railtie do
+  context 'before_configure' do
+    context 'without a config' do
+      it 'does nothing' do
+        expect(rails('runner "print Unifig.respond_to?(:foo)"')).to eql 'false'
+      end
+    end
+
+    context 'with a config' do
+      before do
+        write_config(<<~YML)
+          config:
+            providers: local
+
+          FOO:
+            value: 'foo'
+        YML
+      end
+
+      it 'writes to Unifig' do
+        expect(rails('runner "print Unifig.foo"')).to eql 'foo'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: unifig-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Lasseigne
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: unifig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Unifig support for Rails.
+email:
+- aaron.lasseigne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.txt
+- README.md
+- lib/generators/unifig/config_generator.rb
+- lib/unifig/rails.rb
+- lib/unifig/rails/version.rb
+- lib/unifig/railtie.rb
+- spec/generators/unifig/config_generator_spec.rb
+- spec/spec_helper.rb
+- spec/unifig/railtie_spec.rb
+homepage: https://github.com/AaronLasseigne/unifig-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/AaronLasseigne/unifig-rails
+  source_code_uri: https://github.com/AaronLasseigne/unifig-rails
+  changelog_uri: https://github.com/AaronLasseigne/unifig-rails/blob/main/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.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Unifig support for Rails.
+test_files:
+- spec/generators/unifig/config_generator_spec.rb
+- spec/spec_helper.rb
+- spec/unifig/railtie_spec.rb