configurious 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b776b2ebd26ec4554b9c10c8667b04c355fb541
+  data.tar.gz: 95adeafd31f2be2412f719dbf3e99a5ce05830f6
+SHA512:
+  metadata.gz: 3339ee7341dfa486a686515db089d185331c2af76c577e69d36adbe21f0a1c1874adbe8e7058ab2fa6ad238bdc1d85dd982b3004b6c94aee38baefb1da8fdd4f
+  data.tar.gz: f969a92c90834317dca3aab6b08da228ac9001b100d945050ff16f33e762a10e3cd4858180983e0b858d114398da6557353622c41554e909d5622ea78b61b0af

data/.gitignore

@@ -0,0 +1,63 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

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 chris-ortman@uiowa.edu. 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/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in configurious.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Chris Ortman
+
+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 @@
+# Configurious
+
+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/configurious`. 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 'configurious'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install configurious
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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]/configurious. 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 Configurious project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/configurious/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "configurious"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/configurious.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "configurious/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "configurious"
+  spec.version       = Configurious::VERSION
+  spec.authors       = ["Chris Ortman"]
+  spec.email         = ["chris-ortman@uiowa.edu"]
+
+  spec.summary       = %q{Script changes to configuration files}
+  spec.description   = %q{A DSL for scripting changes to configuration files}
+  spec.homepage      = "https://github.com/chrisortman/configurious"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '> 1'
+  spec.add_dependency 'commander'
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

data/exe/configurious

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require "configurious"
+
+Configurious::CLI.new.run

data/lib/configurious/operations.rb

@@ -0,0 +1,146 @@
+require 'byebug'
+require 'active_support/core_ext/hash'
+
+module Configurious
+  module Operations
+    class OperationBase
+
+      attr_accessor :path, :content
+
+      def simple_path?
+        !@path.include?('.')
+      end
+
+      def normalize_content!
+        if @content.is_a? Hash
+          @content.stringify_keys!
+        end
+      end
+
+      # Handles retrieving the content
+      # we really want to update from the
+      # content that is passed in
+      #
+      # It's expected that the outer most
+      # node comes in and then we need to
+      # look at our key and if we have a
+      # path we need to traverse it
+      def select_node(dict)
+        if simple_path?
+          [path, dict]
+        else
+          traverse_path(path,dict)
+        end
+
+      end
+
+      def traverse_path(path, dict)
+        @traverse_messages = ["Traversing path #{path}"]
+
+        path_parts = path.split('.')
+        piece = dict
+
+        path_parts[0..-2].each do |key|
+
+          case
+          when piece.is_a?(Hash) && piece.has_key?(key)
+            @traverse_messages << "Traversed path part #{key}"
+            piece = piece[key]
+          when piece.is_a?(String)
+            @traverse_messages << "Tried traversing to #{key} but the current piece #{piece} is not a hash"
+            return [key, nil]
+          else
+            @traverse_messages << "Could not find #{key} in current piece. Existing Keys: #{piece.keys.join(',')}"
+            return [key, nil]
+          end
+        end
+
+        [path_parts.last, piece]
+
+      end
+
+      def apply(existing_content)
+        self.normalize_content!
+
+        key, dict = select_node(existing_content)
+        if dict && dict.is_a?(Hash)
+          do_operation(dict, key)
+        elsif dict.is_a?(String)
+          raise "It looks like you selected a value when you meant to select a dictionary. Path #{path} resolves to #{dict}"
+        else
+          extra = @traverse_messages&.join("\n") || ""
+          raise "No node at path '#{path}'\n #{extra}"
+        end
+      end
+
+      # Performs the actual transform
+      # Is given the dictionary to transform
+      # and the key that should be transformed
+      def do_operation(dict, key)
+
+      end
+    end
+
+    class Replace < OperationBase
+
+      attr_accessor :part
+
+      def do_operation(dict, key)
+
+        raise "Cannot replace key '#{key}' because it does not already exist" unless dict.has_key?(key)
+
+        if @part
+          old = dict[key]
+          dict[key] = old.gsub(@part,@content)
+        else
+          dict[key] = @content
+        end
+      end
+
+    end
+
+    class Add < OperationBase
+
+      def do_operation(dict, key)
+
+        raise "Cannot add element, key already exists: #{key}" if dict.has_key?(key)
+
+        dict[key] = self.content
+      end
+    end
+
+    class Update < OperationBase
+
+      def applies(&block)
+        @transform = Configurious::Transformer.new
+        case block.arity
+        when 0
+          @transform.instance_eval(&block)
+        else
+          yield @transform
+        end
+      end
+
+      def do_operation(dict, key)
+        @transform.apply(dict[key])
+      end
+
+    end
+
+    class Remove < OperationBase
+
+      def do_operation(dict, key)
+        dict.delete(key)
+      end
+
+    end
+
+    class ChangeKey < OperationBase
+
+      def do_operation(dict, key)
+        v = dict.delete(key)
+        dict[content] = v
+      end
+    end
+  end
+end

data/lib/configurious/transformer.rb

@@ -0,0 +1,60 @@
+require 'configurious/operations'
+
+module Configurious
+
+  class Transformer
+
+    def initialize
+      @steps = []
+    end
+
+    def add(path, value)
+      op = Configurious::Operations::Add.new
+      op.path = path
+      op.content = value
+      @steps << op
+    end
+
+    def replace(path, with:, part: nil)
+      r = Configurious::Operations::Replace.new
+      r.path = path
+      r.part = part
+      r.content = with
+      @steps << r
+    end
+
+    def change(path, to:)
+      r = Configurious::Operations::Replace.new
+      r.path = path
+      r.content = to
+      @steps << r
+    end
+
+    def update(path, &block)
+      r = Configurious::Operations::Update.new
+      r.path = path
+      r.applies(&block)
+      @steps << r
+    end
+
+    def remove(path)
+      r = Configurious::Operations::Remove.new
+      r.path = path
+      @steps << r
+    end
+
+    def change_key(path, to:)
+      r = Configurious::Operations::ChangeKey.new
+      r.path = path
+      r.content = to
+      @steps << r
+    end
+
+    def apply(content)
+      @steps.each do |t|
+        t.apply(content)
+      end
+      content
+    end
+  end
+end

data/lib/configurious/version.rb

@@ -0,0 +1,3 @@
+module Configurious
+  VERSION = "0.3.0"
+end

data/lib/configurious.rb

@@ -0,0 +1,59 @@
+require 'yaml'
+require 'commander'
+
+require "configurious/version"
+require "configurious/transformer"
+
+module Configurious
+  # Your code goes here...
+  def self.transform(file)
+    contents = YAML.load_file file
+    transformer = Transformer.new
+    yield transformer
+    transformer.apply(contents)
+    contents.to_yaml
+  end
+
+  def self.apply(ifile, script)
+    Configurious.transform(ifile) do |t|
+      t.instance_eval script
+    end
+  end
+
+  class CLI
+
+    include Commander::Methods
+    # include whatever modules you need
+
+    def run
+      program :name, 'configurious'
+      program :version, Configurious::VERSION
+      program :description, 'Allows scripting of changes to yaml files'
+
+      command :poop do |c|
+        c.syntax = "configurious poop"
+        c.summary = "It's poopy"
+        c.action do |args, options|
+          puts "I have #{args.inspect}"
+
+        end
+      end
+
+      command :apply do |c|
+        c.syntax = 'configurious apply [options]'
+        c.summary = ''
+        c.description = ''
+        c.example 'description', 'command example'
+        c.action do |args, options|
+
+          tfile, ifile = args
+          result = Configurious.apply(ifile,File.read(tfile))
+          puts result
+        end
+      end
+
+      run!
+    end
+  end
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: configurious
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Chris Ortman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: commander
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A DSL for scripting changes to configuration files
+email:
+- chris-ortman@uiowa.edu
+executables:
+- configurious
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- configurious.gemspec
+- exe/configurious
+- lib/configurious.rb
+- lib/configurious/operations.rb
+- lib/configurious/transformer.rb
+- lib/configurious/version.rb
+homepage: https://github.com/chrisortman/configurious
+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.6.14.3
+signing_key: 
+specification_version: 4
+summary: Script changes to configuration files
+test_files: []