strings2conf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f3a87ca23a209fcb1b754913a39396d39ce3929
+  data.tar.gz: 8f781b38b83d3ea9bbe080f624fe05424b844932
+SHA512:
+  metadata.gz: 24fc1cc16778eea2637b80f3424fc1a23c32d3ef3a9823578fb36f35bfdb1eddbe49345674f166e6e8ab229eb24b875c4c50f1a0f153f0bb10ca296c548d3ffc
+  data.tar.gz: 9b9b22fc708cc37236e0462cf63ecc8505088cd8b6e71d35a18c9ed19a04f01caf032bdeb68f95a6da54432ce0f690d863d692daca609f126c81d8edd586caab

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# I like Puppet hash behavior
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+# Not until RubyMine learns to indent these properly
+Style/MultilineMethodCallIndentation:
+  Enabled: false

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 thepegasd@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 [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,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vladimir Tyshkevich
+
+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,49 @@
+# Strings2conf
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strings2conf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strings2conf
+
+## Usage
+
+```bash
+bundle exec bin/simple_convert path/to/json
+```
+or something like this: 
+```ruby
+require 'puppet-strings'
+require 'strings2conf'
+
+PuppetStrings.generate(:json => 'path/to/module.json')
+Strings2conf.convert(File.read('path/to/module.json'))
+```
+
+## 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/v0v04ka/strings2conf. 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 Strings2conf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/strings2conf/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/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/bin/simple_convert

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'strings2conf'
+
+puts Strings2conf.convert(File.read(ARGV[0]))

data/lib/strings2conf/version.rb

@@ -0,0 +1,3 @@
+module Strings2conf
+  VERSION = '0.1.0'
+end

data/lib/strings2conf.rb

@@ -0,0 +1,53 @@
+require 'strings2conf/version'
+require 'json'
+require 'erb'
+include ERB::Util
+
+module Strings2conf
+  class Util
+    DEFAULT_CODE_BLOCK_PARAMETERS = {
+      linenumbers: true,
+      theme:       'RDark',
+    }.freeze
+
+    def self.code_block(code, params = {})
+      ac_params = DEFAULT_CODE_BLOCK_PARAMETERS
+        .merge(params)
+        .map { |name, value|
+          "  <ac:parameter ac:name=\"#{name}\">#{value}</ac:parameter>"
+        }
+        .join("\n")
+
+      <<~HTML
+        <ac:structured-macro ac:name="code">
+        #{ac_params}
+          <ac:plain-text-body><![CDATA[#{code}]]></ac:plain-text-body>
+        </ac:structured-macro>
+      HTML
+    end
+
+    def self.parse_param(instance, param)
+      name     = param['name']
+      types    = if param['types']
+        " [ #{param['types'].map { |t| "<code>#{t}</code>" }.join(',')} ] "
+      else
+        ''
+      end
+      defaults = if instance.key?('defaults') and instance['defaults'].key?(name)
+        " (defaults to: <code>#{h instance['defaults'][name]}</code>) "
+      else
+        ''
+      end
+      <<~HTML
+        <li><strong><code>#{name}</code></strong>#{types}#{defaults}#{h param['text']}</li>
+      HTML
+    end
+  end
+
+  def self.convert(json)
+    @data         = JSON.parse json
+    template_path = File.dirname(File.expand_path(__FILE__)) + '/templates/confluence.html.erb'
+    ERB.new(File.read(template_path), nil, '-').result(binding)
+  end
+
+end

data/lib/templates/confluence.html.erb

@@ -0,0 +1,158 @@
+<%#
+
+  Table of Contents
+
+-%>
+<ac:structured-macro ac:name="toc">
+  <ac:parameter ac:name="maxLevel">2</ac:parameter>
+</ac:structured-macro>
+<%#
+
+  Parse classes
+
+-%>
+<%- if @data['puppet_classes'].any? -%>
+  <h1>Classes</h1>
+  <%- @data['puppet_classes'].each do |puppet_class| -%>
+    <h2><%= puppet_class['name'] %></h2>
+    <%- if puppet_class['docstring']['tags'] -%>
+      <p><%= h(puppet_class['docstring']['text']).gsub("\n\n", "<br/>\n") %></p>
+      <%- api = puppet_class['docstring']['tags'].select { |a| a['tag_name'].eql? 'api' } -%>
+      <%- if api.any? and api[0]['text'].eql? 'private' -%>
+        <ac:structured-macro ac:name="note">
+          <ac:rich-text-body>
+            <p>This class is private. It's intended solely for internal module usage.</p>
+          </ac:rich-text-body>
+        </ac:structured-macro>
+      <%- end -%>
+      <%- for tag in puppet_class['docstring']['tags'] -%>
+        <%- unless %w(param example api).include? tag['tag_name'] -%>
+          <h3><%= tag['tag_name'].capitalize %></h3>
+          <p><%= h tag['name'] %> <%= h tag['text'] %></p>
+        <%- end -%>
+      <%- end -%>
+      <%- params = puppet_class['docstring']['tags'].select { |a| a['tag_name'].eql? 'param' } -%>
+      <%- if params.any? -%>
+        <h3>Parameters</h3>
+        <ul>
+          <%- for param in params -%>
+            <%= Strings2conf::Util::parse_param(puppet_class, param) %>
+          <%- end -%>
+        </ul>
+      <%- end -%>
+      <%- examples = puppet_class['docstring']['tags'].select { |a| a['tag_name'].eql? 'example' } -%>
+      <%- if examples.any? -%>
+        <h3>Examples</h3>
+        <%- examples.each do |example| -%>
+          <%= Strings2conf::Util::code_block(example['text'], title: example['name'], language: :ruby) -%>
+        <%- end -%>
+      <%- end -%>
+    <%- end -%>
+    <%= Strings2conf::Util::code_block(puppet_class['source'], title: puppet_class['file'], collapse: true, language: :ruby) -%>
+  <%- end -%>
+<%- end -%>
+<%#
+
+  Parse defined types
+
+-%>
+<%- if @data['defined_types'].any? -%>
+  <h1>Defined Types</h1>
+  <%- @data['defined_types'].each do |defined_type| -%>
+    <h2><%= defined_type['name'] %></h2>
+    <%- if defined_type['docstring']['tags'] -%>
+      <p><%= h(defined_type['docstring']['text']).gsub("\n\n", "<br/>\n") %></p>
+      <%- api = defined_type['docstring']['tags'].select { |a| a['tag_name'].eql? 'api' } -%>
+      <%- if api.any? and api[0]['text'].eql? 'private' -%>
+        <ac:structured-macro ac:name="note">
+          <ac:rich-text-body>
+            <p>This defined type is private. It's intended solely for internal module usage.</p>
+          </ac:rich-text-body>
+        </ac:structured-macro>
+      <%- end -%>
+      <%- for tag in defined_type['docstring']['tags'] -%>
+        <%- unless %w(param example api).include? tag['tag_name'] -%>
+          <h3><%= tag['tag_name'].capitalize %></h3>
+          <p><%= h tag['name'] %> <%= h tag['text'] %></p>
+        <%- end -%>
+      <%- end -%>
+      <%- params = defined_type['docstring']['tags'].select { |a| a['tag_name'].eql? 'param' } -%>
+      <%- if params.any? -%>
+        <h3>Parameters</h3>
+        <ul>
+          <%- for param in params -%>
+            <%= Strings2conf::Util::parse_param(defined_type, param) %>
+          <%- end -%>
+        </ul>
+      <%- end -%>
+      <%- examples = defined_type['docstring']['tags'].select { |a| a['tag_name'].eql? 'example' } -%>
+      <%- if examples.any? -%>
+        <h3>Examples</h3>
+        <%- examples.each do |example| -%>
+          <%= Strings2conf::Util::code_block(example['text'], title: example['name'], language: :ruby) -%>
+        <%- end -%>
+      <%- end -%>
+    <%- end -%>
+    <%= Strings2conf::Util::code_block(defined_type['source'], title: defined_type['file'], collapse: true, language: :ruby) -%>
+  <%- end -%>
+<%- end -%>
+<%#
+
+  Parse functions
+
+-%>
+<%- if @data['puppet_functions'].any? -%>
+  <h1>Functions</h1>
+  <%- @data['puppet_functions'].each do |puppet_function| -%>
+    <h2><%= puppet_function['name'] %></h2>
+    <p><%= h(puppet_function['docstring']['text']).gsub("\n\n", "<br/>\n") %></p>
+    <%-
+      tags = puppet_function['docstring']['tags']
+      examples = tags.select { |a| a['tag_name'].eql? 'example' }
+      overloads = tags.select { |a| a['tag_name'].eql? 'overload' }
+    -%>
+    <%- if overloads.any? -%>
+      <%- overloads.each_with_index do |overload, index| -%>
+        <h3>Signature #<%= index + 1 %></h3>
+        <%= Strings2conf::Util::code_block(overload['signature'], language: :ruby, linenumbers: false) -%>
+        <%- tags = overload['docstring']['tags'] -%>
+        <%- params = tags.select { |a| a['tag_name'].eql? 'param' } -%>
+        <%- returns = tags.select { |a| a['tag_name'].eql? 'return' } -%>
+        <%- if params.any? -%>
+          <h3>Parameters</h3>
+          <%- params.each do |param| -%>
+            <%= Strings2conf::Util::parse_param(overload, param) %>
+          <%- end -%>
+        <%- end -%>
+        <%- if returns.any? -%>
+          <h3>Returns</h3>
+          <%- returns.each do |ret| -%>
+            <p>[ <code><%= ret['types'].join(',') %></code> ] <%= ret['text'] %></p>
+          <%- end -%>
+        <%- end -%>
+      <%- end -%>
+    <%- else -%>
+      <%- params = tags.select { |a| a['tag_name'].eql? 'param' } -%>
+      <%- returns = tags.select { |a| a['tag_name'].eql? 'return' } -%>
+      <%- if params.any? -%>
+        <h3>Parameters</h3>
+        <%- params.each do |param| -%>
+          <%= Strings2conf::Util::parse_param(puppet_function, param) %>
+        <%- end -%>
+      <%- end -%>
+      <%- if returns.any? -%>
+        <h3>Returns</h3>
+        <%- returns.each do |ret| -%>
+          <p>[ <code><%= ret['types'].join(',') %></code> ] <%= ret['text'] %></p>
+        <%- end -%>
+      <%- end -%>
+    <%- end -%>
+    <%- if examples.any? -%>
+      <h3>Examples</h3>
+      <%- examples.each do |example| -%>
+        <%= Strings2conf::Util::code_block(example['text'], title: example['name'], language: :ruby) -%>
+      <%- end -%>
+    <%- end -%>
+    <%= Strings2conf::Util::code_block(puppet_function['source'], title: puppet_function['file'], collapse: true, language: :ruby) -%>
+  <%- end -%>
+<%- end -%>

data/strings2conf.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'strings2conf/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'strings2conf'
+  spec.version = Strings2conf::VERSION
+  spec.authors = ['Vladimir Tyshkevich', 'Eugene Piven']
+  spec.email   = ['vtyshkevich@iponweb.net', 'epiven@iponweb.net']
+
+  spec.summary  = 'Convert puppet-strings JSON output to Confluence storage format'
+  spec.homepage = 'https://github.com/pegasd/strings2conf'
+  spec.license  = 'MIT'
+
+  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_runtime_dependency 'puppet-strings', '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: strings2conf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladimir Tyshkevich
+- Eugene Piven
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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'
+description: 
+email:
+- vtyshkevich@iponweb.net
+- epiven@iponweb.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- bin/simple_convert
+- lib/strings2conf.rb
+- lib/strings2conf/version.rb
+- lib/templates/confluence.html.erb
+- strings2conf.gemspec
+homepage: https://github.com/pegasd/strings2conf
+licenses:
+- MIT
+metadata: {}
+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.11
+signing_key: 
+specification_version: 4
+summary: Convert puppet-strings JSON output to Confluence storage format
+test_files: []