awesome_xml_dsl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42ac9228475c201a5f1dbeba16fd0643f8e49ba7e19ca8e4e4d98fb8f31652f2
+  data.tar.gz: 2e702e09f7b57074d46c2da30fc0e816fda3fef6d4e3ff1ffe0a19c011e135fd
+SHA512:
+  metadata.gz: 560635f64613ff777f505e69beb33d4b51fbeb05346194bf97d6c36bde326a7a26b60d7a3b5dabb8fd543acc739a848bd860d674ea85c82043fc998f3f37f1a9
+  data.tar.gz: '0729cede90811991feb0606f5d974b1668b1e35befd4a142ce0e5b677ec0bd9d9a7e3926e0b485a68f72548de5e7abcb82a53bba12ef86df939ad66e2d84445f'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

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 phec06@gmail.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xml_dsl.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    xml_dsl (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  xml_dsl!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Pedro Bernardes
+
+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,44 @@
+# XmlDsl
+
+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/xml_dsl`. 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 'xml_dsl'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install xml_dsl
+
+## 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]/xml_dsl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/xml_dsl/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the XmlDsl project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/xml_dsl/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'xml_dsl'
+
+# 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/lib/lib/core_extensions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+unless Hash.respond_to? :deep_merge
+  class Hash
+    def deep_merge(other_hash, &block)
+      dup.deep_merge!(other_hash, &block)
+    end
+
+    def deep_merge!(other_hash, &block)
+      merge!(other_hash) do |key, this_val, other_val|
+        if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+          this_val.deep_merge(other_val, &block)
+        elsif block_given?
+          block.call(key, this_val, other_val)
+        else
+          other_val
+        end
+      end
+    end
+  end
+end

data/lib/xml_dsl.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'xml_dsl/version'
+require 'xml_dsl/generator'
+require 'xml_dsl/tag'
+require 'xml_dsl/attribute'
+require 'xml_dsl/partial'
+require 'xml_dsl/options_parser'
+require 'xml_dsl/attribute_options_parser'
+require 'lib/core_extensions'
+
+module XmlDsl
+  class RequiredValueNotPresent < StandardError; end
+
+  def self.root
+    File.dirname __dir__
+  end
+end

data/lib/xml_dsl/as_one_file.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+final = ''
+
+Dir['*.rb'].each do |file|
+  next if ['as_one_file.rb', 'version.rb'].include? file
+
+  final += File.read(file).split("\n")[3..-2].join("\n") + "\n\n"
+end
+
+puts "module XmlDsl\n#{final.rstrip}\nend"

data/lib/xml_dsl/attribute.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module XmlDsl
+  class Attribute
+    def initialize(name, value)
+      @name = name
+      @value = value
+    end
+
+    def to_xml
+      return "#{@name}=\"#{@value}\""
+    end
+  end
+end

data/lib/xml_dsl/attribute_options_parser.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module XmlDsl
+  class AttributeOptionsParser
+    def initialize(original_options)
+      @as = original_options[:as] || original_options[:require] || original_options[:if]
+      @options_parser = OptionsParser.new original_options
+    end
+
+    def self.parse(options)
+      new options
+    end
+
+    def each
+      @options_parser.each do |parsed_options|
+        value = parsed_options[:locals][@as]
+        yield value
+      end
+    end
+  end
+end

data/lib/xml_dsl/data_source.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module XmlDsl
+  class DataSource
+    def initialize(object:)
+      @object = object
+    end
+
+    def can_read?(object, key)
+      return object.key?(key) if object.respond_to?(:key?)
+
+      object.respond_to?(key)
+    end
+
+    def read(object, key)
+      return object[key] if object.is_a? Hash
+
+      object.send key
+    end
+
+    def method_missing(m, *args, &block)
+      return @data_source[m] if @data_source.is_a? Hash
+
+      @data_source.send(m, *args, &block)
+    end
+  end
+end

data/lib/xml_dsl/generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module XmlDsl
+  class Generator
+    def initialize(data_source:, template:, version_tag: '<?xml version="1.0" encoding="utf-8"?>')
+      @data_source = data_source
+      @template = template
+      @version_tag = version_tag
+
+      @template_dir = File.dirname @template
+      @tags = []
+      @generator = self
+      @depth = -1
+    end
+
+    def generate
+      instance_eval File.read(@template), @template.to_s
+      ([@version_tag] + @tags.map(&:to_xml) + ['']).join "\n"
+    end
+
+    def tag(name, options = {}, &block)
+      OptionsParser.parse(options).each do |parsed_options|
+        xml_tag = Tag.new(name, self, 0, parsed_options)
+        @tags.push xml_tag
+        xml_tag.instance_eval(&block) if block_given?
+      end
+    end
+
+    def partial(name, options = {}, context = self, context_options = {})
+      file_name = File.join(@template_dir, "_#{name}.xml.rb").to_s
+
+      OptionsParser.parse(options, context_options).each do |parsed_options|
+        Partial.new(file_name, context, parsed_options).eval
+      end
+    end
+
+    def method_missing(m, *args, &block)
+      return @data_source[m] if @data_source.is_a? Hash
+
+      @data_source.send(m, *args, &block)
+    end
+  end
+end

data/lib/xml_dsl/options_parser.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module XmlDsl
+  class OptionsParser
+    attr_accessor :options
+
+    def initialize(original_options, parent_options = {})
+      self.options = original_options.clone
+      options[:locals] ||= {}
+
+      return unless parent_options.key?(:locals)
+
+      options[:locals] = parent_options[:locals].deep_merge(options[:locals])
+    end
+
+    def self.parse(options, parent_options = {})
+      new options, parent_options
+    end
+
+    def each
+      return if options.key?(:if) && !options[:if]
+
+      if options.key?(:collection) && options.key?(:as)
+        return unless options[:collection].respond_to? :each
+
+        as = options[:as]
+        collection = options[:collection]
+        delete_options :collection, :as
+
+        collection.each do |element|
+          options[:locals][as] = element
+
+          yield options
+        end
+      elsif (options.key?(:if) || options.key?(:require)) && options.key?(:of)
+        return if options.key?(:if) && !(can_read? options[:of], options[:if])
+
+        if options.key?(:require) && !can_read?(options[:of], options[:require])
+          raise RequiredValueNotPresent, "Can't read required key #{options[:require]} of #{options[:of]}"
+        end
+
+        accessor = options[:require] || options[:if]
+        of = options[:of]
+        as = options[:as] || accessor
+
+        delete_options :if, :of, :as, :require
+
+        options[:locals][as] = read of, accessor
+        yield options
+      else
+        yield options
+      end
+    end
+
+    def delete_options(*keys)
+      keys.each do |key|
+        options.delete key
+      end
+    end
+
+    def can_read?(object, key)
+      return object.key?(key) if object.respond_to?(:key?)
+
+      object.respond_to?(key)
+    end
+
+    def read(object, key)
+      return object[key] if object.is_a? Hash
+
+      object.send key
+    end
+  end
+end

data/lib/xml_dsl/partial.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module XmlDsl
+  class Partial
+    def initialize(file_name, context, options = {})
+      @context = context
+      @file_name = file_name
+      @options = options
+    end
+
+    def tag(name, options = {}, &block)
+      @context.tag name, options.deep_merge(@options), &block
+    end
+
+    def a(*args)
+      @context.a(*args)
+    end
+
+    def eval
+      contents = File.read @file_name
+      instance_eval contents, @file_name
+    end
+
+    def method_missing(m, *args, &block)
+      return @options[:locals][m] if @options[:locals]&.key?(m)
+
+      @context.send(m, *args, &block)
+    end
+  end
+end

data/lib/xml_dsl/tag.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module XmlDsl
+  class Tag
+    def initialize(name, generator, depth, options = {})
+      @name = name
+      @generator = generator
+      @depth = depth
+      @options = options
+
+      @attributes = []
+      @tags = []
+    end
+
+    # Block evaluation
+    def a(name, options_or_value = {})
+      # It is options
+      if options_or_value.is_a? Hash
+        AttributeOptionsParser.parse(options_or_value).each do |value|
+          attribute = Attribute.new(name, value)
+          @attributes.push attribute
+        end
+
+        return
+      end
+
+      # It is a value
+      attribute = Attribute.new(name, options_or_value)
+      @attributes.push attribute
+    end
+
+    def tag(name, options = {}, &block)
+      OptionsParser.parse(options, @options).each do |parsed_options|
+        xml_tag = Tag.new(name, @generator, @depth + 1, parsed_options)
+        @tags.push xml_tag
+        xml_tag.instance_eval(&block) if block_given?
+      end
+    end
+
+    def partial(name, options = {})
+      @generator.partial(name, options, self, @options)
+    end
+
+    # XML Generation
+    def to_xml
+      spaces = ' ' * @depth * 2
+      start = "#{spaces}<#{@name}#{attributes_as_xml(spaces + '  ')}"
+
+      return start + ' />' if @tags.length.zero?
+
+      [start + '>', @tags.map(&:to_xml).join("\n"), "#{spaces}</#{@name}>"].join "\n"
+    end
+
+    def attributes_as_xml(spaces)
+      return '' unless @attributes.any?
+      return " #{@attributes.first.to_xml}" if @attributes.length == 1
+
+      ([''] + @attributes.map(&:to_xml).compact.map { |attribute| "#{spaces}#{attribute}" }).join("\n")
+    end
+
+    def method_missing(m, *args, &block)
+      return @options[:locals][m] if @options[:locals]&.key?(m)
+
+      @generator.send(m, *args, &block)
+    end
+  end
+end

data/lib/xml_dsl/version.rb

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

data/xml_dsl.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/xml_dsl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'awesome_xml_dsl'
+  spec.version       = XmlDsl::VERSION
+  spec.authors       = ["Pedro 'Fedeaux' Bernardes"]
+  spec.email         = ['phec06@gmail.com']
+
+  spec.summary       = 'A simple yet powerful ruby dsl for generating XML files'
+  spec.homepage      = 'https://github.com/fedeaux/xml_dsl'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fedeaux/xml_dsl'
+  spec.metadata['changelog_uri'] = 'https://github.com/fedeaux/xml_dsl'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: awesome_xml_dsl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro 'Fedeaux' Bernardes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-02 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- phec06@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lib/core_extensions.rb
+- lib/xml_dsl.rb
+- lib/xml_dsl/as_one_file.rb
+- lib/xml_dsl/attribute.rb
+- lib/xml_dsl/attribute_options_parser.rb
+- lib/xml_dsl/data_source.rb
+- lib/xml_dsl/generator.rb
+- lib/xml_dsl/options_parser.rb
+- lib/xml_dsl/partial.rb
+- lib/xml_dsl/tag.rb
+- lib/xml_dsl/version.rb
+- xml_dsl.gemspec
+homepage: https://github.com/fedeaux/xml_dsl
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/fedeaux/xml_dsl
+  source_code_uri: https://github.com/fedeaux/xml_dsl
+  changelog_uri: https://github.com/fedeaux/xml_dsl
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A simple yet powerful ruby dsl for generating XML files
+test_files: []