puzzly_api_plugin 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab7afadfc80e147f72a36d7d85903ee358d36f5153825750ebc2d70732aae4f1
+  data.tar.gz: f4426b0cf409e74b779cf12019f8a974507cb2ae8e03b17fe91410979ffccbbf
+SHA512:
+  metadata.gz: 21c4a4c57638f088ce382caeca5083db6fe525f517c22e31b252594efe46ce75bddb719204ff64b4a1a12922eddd9d520d09c7a1186aeaf2e5606792f487deb0
+  data.tar.gz: 2843fc7f00edbe5bcaadec2ba5ab093b4bc915f35129f52f2f19293ccc7e07d5ce8630912b5be9d96fde2684a4dec8f8ba5430230b459bc61ed5c692d45a99b0

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      - run: "sh ./script/ci-build"
+      - save_cache:
+          key: gem-cache-{{ .Branch }}-{{ .Revision }}
+          paths:
+            - vendor/bundle
+
+  release:
+    docker:
+      - image: circleci/ruby
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      - add_ssh_keys
+      - restore_cache:
+          keys:
+            - gem-cache-{{ .Branch }}-{{ .Revision }}
+      - run: "sh ./script/ci-release"
+
+workflows:
+  version: 2
+  build-deploy:
+    jobs:
+      - build:
+          context: Archmix
+      - release:
+          context: Archmix
+          requires:
+            - build
+          filters:
+            branches:
+              only: master

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+
+**/.jekyll-cache
+**/dest

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Style/Documentation:
+    Enabled: false
+
+Metrics/ParameterLists:
+    Enabled: false
+
+Metrics/LineLength:
+    Max: 200
+
+Metrics/AbcSize:
+    Max: 20

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puzzly-generator.gemspec
+gemspec
+
+gem 'jekyll', ENV['JEKYLL_VERSION'] if ENV['JEKYLL_VERSION']

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Braz
+
+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/Linux Mint Ruby Setup.md

@@ -0,0 +1 @@
+sudo apt install build-essential ruby ruby-dev

data/README.md

@@ -0,0 +1,17 @@
+# PuzzlyApiPlugin
+
+This Gem collect all metadata stored in the Archmix Puzzly Portal and generate all json needed for UI to work.
+
+## 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/archmix/puzzly-generator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 'puzzly/generator'
+
+# 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/puzzly_api_plugin/collection/apis.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class ApisCollection < Collection
+    include Singleton
+
+    def add(document)
+      api = Api.create document
+      add_metadata api
+    end
+
+    def get_by_modules(modules)
+      select { |_id, api| modules.key?(api.module_id) }
+    end
+
+    def get_by_module(mod)
+      select { |_id, api| mod.id <=> api.module_id }
+    end
+  end
+end

data/lib/puzzly_api_plugin/collection/caches.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class CachesCollection < Collection
+    include Singleton
+
+    def add(document)
+      cache = Cache.create(document)
+      add_metadata cache
+    end
+
+    def get_by_modules(modules)
+      select { |_id, cache| modules.key?(cache.module_id) }
+    end
+
+    def get_by_module(mod)
+      select { |_id, cache| mod.id <=> cache.module_id }
+    end
+  end
+end

data/lib/puzzly_api_plugin/collection/collection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class Collection < JSONable
+    def identities
+      identities = []
+
+      each do |_id, metadata|
+        identity = metadata.to_identity
+        identities.push identity
+      end
+
+      identities
+    end
+
+    def add_metadata(metadata)
+      self[metadata.id] = metadata
+    end
+
+    def get_by_id(id)
+      self[id]
+    end
+  end
+end

data/lib/puzzly_api_plugin/collection/contexts.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class ContextsCollection < Collection
+    include Singleton
+
+    def add(document)
+      context = Context.create(document)
+      add_metadata context
+    end
+  end
+end

data/lib/puzzly_api_plugin/collection/modules.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class ModulesCollection < Collection
+    include Singleton
+
+    def add(document)
+      mod = Module.create(document)
+      add_metadata mod
+    end
+
+    def get_by_context(context)
+      select { |_id, mod| mod.context_id <=> context.id }
+    end
+  end
+end

data/lib/puzzly_api_plugin/collection/queries.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class QueriesCollection < Collection
+    include Singleton
+
+    def add(document)
+      query = Query.create(document)
+      add_metadata query
+    end
+
+    def get_by_modules(modules)
+      select { |_id, query| modules.key?(query.module_id) }
+    end
+
+    def get_by_module(mod)
+      select { |_id, query| mod.id <=> query.module_id }
+    end
+  end
+end

data/lib/puzzly_api_plugin/collection/schemas.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class SchemasCollection < Collection
+    include Singleton
+
+    def add(document)
+      schema = Schema.create(document)
+      add_metadata schema
+    end
+
+    def get_by_context(context)
+      select { |_id, schema| schema.context_id <=> context.id }
+    end
+  end
+end

data/lib/puzzly_api_plugin/collection/tables.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class TablesCollection < Collection
+    include Singleton
+
+    def add(document)
+      table = Table.create(document)
+      add_metadata table
+    end
+
+    def get_by_modules(modules)
+      select { |_id, table| modules.key?(table.module_id) }
+    end
+
+    def get_by_module(mod)
+      select { |_id, table| mod.id <=> table.module_id }
+    end
+  end
+end

data/lib/puzzly_api_plugin/collection/topics.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class TopicsCollection < Collection
+    include Singleton
+
+    def add(document)
+      topic = Topic.create(document)
+      add_metadata topic
+    end
+
+    def get_by_modules modules
+      select { |_id, topic| modules.key?(topic.module_id) }
+    end
+
+    def get_by_module mod
+      select { |_id, topic| mod.id <=> topic.module_id }
+    end
+
+    def get_by_schema schema
+      select { |_id, topic| schema.id <=> topic.schema_id }
+    end
+  end
+end

data/lib/puzzly_api_plugin/fields.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class MetadataFields
+    ID = 'id'
+    NAME = 'name'
+    PATH = 'path'
+    DESCRIPTION = 'description'
+    SPECIFICATION = 'specification'
+    CONTEXT_ID = 'contextId'
+    MODULE_ID = 'moduleId'
+    SCHEMA_ID = 'schemaId'
+
+    SUMMARY = 'summary'
+    CONTEXT = 'context'
+    MODULE = 'module'
+    SCHEMA = 'schema'
+
+    APIS = 'apis'
+    NUMBER_OF_APIS = 'numberOfApis'
+
+    CACHES = 'caches'
+    NUMBER_OF_CACHES = 'numberOfCaches'
+    
+    CONTEXTS = 'contexts'
+    NUMBER_OF_CONTEXTS = 'numberOfContexts'
+    
+    MODULES = 'modules'
+    NUMBER_OF_MODULES = 'numberOfModules'
+    
+    QUERIES = 'queries'
+    NUMBER_OF_QUERIES = 'numberOfQueries'
+    
+    SCHEMAS = 'schemas'
+    NUMBER_OF_SCHEMAS = 'numberOfSchemas'
+    
+    TABLES = 'tables'
+    NUMBER_OF_TABLES = 'numberOfTables'
+    
+    TOPICS = 'topics'
+    NUMBER_OF_TOPICS = 'numberOfTopics'
+  end
+
+  class YAMLFields
+    API_ID = 'apiId'
+    API_NAME = 'apiName'
+    API_DESCRIPTION = 'apiDescription'
+    API_SPECIFICATION = 'apiSpecification'
+
+    CACHE_ID = 'cacheId'
+    CACHE_NAME = 'cacheName'
+    CACHE_DESCRIPTION = 'cacheDescription'
+    CACHE_SPECIFICATION = 'cacheSpecification'
+
+    CONTEXT_ID = 'contextId'
+    CONTEXT_NAME = 'contextName'
+    CONTEXT_DESCRIPTION = 'contextDescription'
+
+    MODULE_ID = 'moduleId'
+    MODULE_NAME = 'moduleName'
+    MODULE_DESCRIPTION = 'moduleDescription'
+
+    QUERY_ID = 'queryId'
+    QUERY_NAME = 'queryName'
+    QUERY_DESCRIPTION = 'queryDescription'
+    QUERY_SPECIFICATION = 'querySpecification'
+
+    SCHEMA_ID = 'schemaId'
+    SCHEMA_NAME = 'schemaName'
+    SCHEMA_DESCRIPTION = 'schemaDescription'
+    SCHEMA_SPECIFICATION = 'schemaSpecification'
+
+    TABLE_ID = 'tableId'
+    TABLE_NAME = 'tableName'
+    TABLE_DESCRIPTION = 'tableDescription'
+    TABLE_SPECIFICATION = 'tableSpecification'
+
+    TOPIC_ID = 'topicId'
+    TOPIC_NAME = 'topicName'
+    TOPIC_DESCRIPTION = 'topicDescription'
+  end
+end

data/lib/puzzly_api_plugin/generator.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class Generator < Jekyll::Generator
+    safe true
+
+    def generate(site)
+      site.documents.each do |document|
+        collection = PuzzlyApiPlugin.const_get("#{document.collection.label.capitalize}Collection").instance
+        collection.add(document)
+      end
+
+      render site, HomeDashboardView.create
+
+      render site, ContextsView.create
+      ContextsCollection.instance.values.each do |context|
+        render site, ContextView.create(context)
+      end
+
+      render site, ModulesView.create
+      ModulesCollection.instance.values.each do |mod|
+        render site, ModuleView.create(mod)
+      end
+
+      render site, SchemasView.create
+      SchemasCollection.instance.values.each do |schema|
+        render site, SchemaView.create(schema)
+      end
+
+      render site, ApisView.create
+      ApisCollection.instance.values.each do |api|
+        render site, ApiView.create(api)
+      end
+
+      render site, CachesView.create
+      CachesCollection.instance.values.each do |cache|
+        render site, CacheView.create(cache)
+      end
+
+      render site, QueriesView.create
+      QueriesCollection.instance.values.each do |query|
+        render site, QueryView.create(query)
+      end
+
+      render site, TablesView.create
+      TablesCollection.instance.values.each do |table|
+        render site, TableView.create(table)
+      end
+
+      render site, TopicsView.create
+      TopicsCollection.instance.values.each do |topic|
+        render site, TopicView.create(topic)
+      end
+    end
+
+    def render(site, view)
+      content = view.render
+      path = view.path
+      site.pages << JSONPage.new(site, site.source, File.dirname(path), File.basename(path), content)
+    end
+  end
+end

data/lib/puzzly_api_plugin/identity.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class Identity < JSONable
+    def self.create(metadata)
+      Identity.new(metadata.id, metadata.name, metadata.path)
+    end
+
+    def initialize(id, name, path)
+      self['id'] = id
+      self['name'] = name
+      self['path'] = path
+    end
+  end
+end

data/lib/puzzly_api_plugin/jsonable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class JSONable < Hash
+    def copy_to_hash(hash)
+      each do |key, value|
+        hash.store(key, value)
+      end
+    end
+
+    def to_s
+      to_json
+    end
+  end
+end

data/lib/puzzly_api_plugin/metadata/api.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class Api < Metadata
+    def self.create(document)
+      Api.new(document,
+              document.data[YAMLFields::MODULE_ID],
+              document.data[YAMLFields::API_ID],
+              document.data[YAMLFields::API_NAME],
+              document.data[YAMLFields::API_DESCRIPTION],
+              document.data[YAMLFields::API_SPECIFICATION])
+    end
+
+    def initialize(document, module_id, id, name, description, specification)
+      super(document, id, name)
+      self[MetadataFields::MODULE_ID] = module_id
+      self[MetadataFields::DESCRIPTION] = description
+      self[MetadataFields::SPECIFICATION] = specification
+    end
+
+    def module_id
+      self[MetadataFields::MODULE_ID]
+    end
+
+    def description
+      self[MetadataFields::DESCRIPTION]
+    end
+
+    def specification
+      self[MetadataFields::SPECIFICATION]
+    end
+  end
+end

data/lib/puzzly_api_plugin/metadata/cache.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class Cache < Metadata
+    def self.create(document)
+      Cache.new(document,
+                document.data[YAMLFields::MODULE_ID],
+                document.data[YAMLFields::CACHE_ID],
+                document.data[YAMLFields::CACHE_NAME],
+                document.data[YAMLFields::CACHE_DESCRIPTION],
+                document.data[YAMLFields::CACHE_SPECIFICATION])
+    end
+
+    def initialize(document, module_id, id, name, description, specification)
+      super(document, id, name)
+      self[MetadataFields::MODULE_ID] = module_id
+      self[MetadataFields::DESCRIPTION] = description
+      self[MetadataFields::SPECIFICATION] = specification
+    end
+
+    def module_id
+      self[MetadataFields::MODULE_ID]
+    end
+
+    def description
+      self[MetadataFields::DESCRIPTION]
+    end
+
+    def specification
+      self[MetadataFields::SPECIFICATION]
+    end
+  end
+end

data/lib/puzzly_api_plugin/metadata/context.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class Context < Metadata
+    def self.create(document)
+      Context.new(document,
+                  document.data[YAMLFields::CONTEXT_ID],
+                  document.data[YAMLFields::CONTEXT_NAME],
+                  document.data[YAMLFields::CONTEXT_DESCRIPTION])
+    end
+
+    def initialize(document, id, name, description)
+      super(document, id, name)
+      self[MetadataFields::DESCRIPTION] = description
+    end
+
+    def description
+      self[MetadataFields::DESCRIPTION]
+    end
+  end
+end

data/lib/puzzly_api_plugin/metadata/metadata.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class Metadata < JSONable
+    def initialize(document, id, name)
+      self[MetadataFields::PATH] = document.collection.label.to_s + document.cleaned_relative_path
+      self[MetadataFields::ID] = id
+      self[MetadataFields::NAME] = name
+    end
+
+    def path
+      self[MetadataFields::PATH]
+    end
+
+    def id
+      self[MetadataFields::ID]
+    end
+
+    def name
+      self[MetadataFields::NAME]
+    end
+
+    def to_identity
+      Identity.create(self)
+    end
+  end
+end

data/lib/puzzly_api_plugin/metadata/module.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PuzzlyApiPlugin
+  class Module < Metadata
+    def self.create(document)
+      Module.new(document,
+                 document.data[YAMLFields::CONTEXT_ID],
+                 document.data[YAMLFields::MODULE_ID],
+                 document.data[YAMLFields::MODULE_NAME],
+                 document.data[YAMLFields::MODULE_DESCRIPTION])
+    end
+
+    def initialize(document, context_id, id, name, description)
+      super(document, id, name)
+      self[MetadataFields::CONTEXT_ID] = context_id
+      self[MetadataFields::DESCRIPTION] = description
+    end
+
+    def context_id
+      self[MetadataFields::CONTEXT_ID]
+    end
+
+    def description
+      self[MetadataFields::DESCRIPTION]
+    end
+  end
+end