netzplan_micro_frontend 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a8d6086791ef531396bb2bae22f5705311a09093f4ee8308411b632037f1acd
+  data.tar.gz: 5ae096f1c54af67363e65124b4c34788e9dfbc921e353623ba2bf7823a9b02ef
+SHA512:
+  metadata.gz: 96c8151310164976f690afad83aaf33dcf2c3c42e33e081d6ad9e9c2362326cd809967df68f532ff57c92742f8762f26e2b60595551b78d76124479981460827
+  data.tar.gz: 32ccc476907231eed61b9540df8d6b1936050a4bf489919a0be81f6a9c056bd683aa039324aab738a8f81e7e0e1e39f163d79c3a7b7876a05bb39a745df9679e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 René Meye
+
+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,28 @@
+# NetzplanMicroFrontend
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'netzplan_micro_frontend'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install netzplan_micro_frontend
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NetzplanMicroFrontend'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/netzplan_micro_frontend/debug_controller.rb

@@ -0,0 +1,7 @@
+class NetzplanMicroFrontend::DebugController < ApplicationController
+
+  def index
+    authorize! :admin, :micro_frontend
+  end
+
+end

data/app/controllers/netzplan_micro_frontend/sources_controller.rb

@@ -0,0 +1,7 @@
+class NetzplanMicroFrontend::SourcesController < ApplicationController
+  #layout "micro_frontend_debug"
+
+  def index
+    authorize! :index, :micro_frontend_sources
+  end
+end

data/app/views/netzplan_micro_frontend/debug/index.html.erb

@@ -0,0 +1,33 @@
+<h1>Micro Frontend Debug</h1>
+
+<h3>CSS</h3>
+<p>
+  Current:
+  <a href="<%=asset_url 'micro_frontend.css'%>"><%=asset_url 'micro_frontend.css'%></a>
+</p>
+<iframe src="<%=asset_url 'micro_frontend.css'%>" frameborder="1" width="100%"></iframe>
+
+<h3>Javascript</h3>
+<p>
+  Current:
+  <a href="<%=asset_pack_url 'micro_frontend.js'%>"><%=asset_pack_url 'micro_frontend.js'%></a>
+</p>
+<iframe src="<%=asset_pack_url 'micro_frontend.js'%>" frameborder="1" width="100%"></iframe>
+
+<h3>Registered Micro-Frontends</h3>
+<ul class="registered_micro_frontends"></ul>
+
+<h3>Registered Models</h3>
+<ul class="registered_models"></ul>
+
+<h3>Registered Collections</h3>
+<ul class="registered_collections"></ul>
+
+<h3>Registered Views</h3>
+<ul class="registered_views"></ul>
+
+<h3>Registered Mapbox Styles</h3>
+<ul class="registered_mapbox_styles"></ul>
+
+<h3>Micro-Frontend-Flow</h3>
+<div class="micro_frontend_flows"></div>

data/app/views/netzplan_micro_frontend/sources/index.json.jbuilder

@@ -0,0 +1,2 @@
+json.javascript asset_pack_url 'micro_frontend.js'
+json.stylesheet asset_url 'micro_frontend.css'

data/lib/generators/netzplan_micro_frontend/install/install_generator.rb

@@ -0,0 +1,11 @@
+module NetzplanMicroFrontend
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      def install
+        generate "netzplan_micro_frontend:install_asset_structure"
+        generate "netzplan_micro_frontend:install_user_rights"
+        generate "netzplan_micro_frontend:install_file_types"
+      end
+    end
+  end
+end

data/lib/generators/netzplan_micro_frontend/install_asset_structure/install_asset_structure_generator.rb

@@ -0,0 +1,25 @@
+module NetzplanMicroFrontend
+  module Generators
+    class InstallAssetStructureGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def create_javascript
+        create_file "app/javascript/templates/.keep"
+        create_file "app/javascript/micro_frontend_management/.keep"
+
+        copy_file "index_mapbox_styles.coffee", "app/javascript/mapbox_styles/index.coffee"
+        copy_file "index_models.js", "app/javascript/models/index.js"
+        copy_file "index_views.coffee", "app/javascript/views/index.coffee"
+
+        copy_file "pack.coffee", "app/javascript/packs/micro_frontend.coffee"
+
+      end
+
+      def create_stylesheets
+        create_file "app/assets/stylesheets/info_window/.keep"
+
+        copy_file "manifest.css", "app/assets/stylesheets/micro_frontend.css"
+      end
+    end
+  end
+end

data/lib/generators/netzplan_micro_frontend/install_asset_structure/templates/index_mapbox_styles.coffee

@@ -0,0 +1,3 @@
+# mapbox_styles
+mapbox_styles = require.context('.', true, /\.coffee/)
+mapbox_styles.keys().forEach(mapbox_styles)

data/lib/generators/netzplan_micro_frontend/install_asset_structure/templates/index_models.js

@@ -0,0 +1,2 @@
+const models = require.context('.', true, /_model\.coffee/)
+models.keys().forEach(models)

data/lib/generators/netzplan_micro_frontend/install_asset_structure/templates/index_views.coffee

@@ -0,0 +1,2 @@
+views = require.context('.', true, /\.coffee/)
+views.keys().forEach(views)

data/lib/generators/netzplan_micro_frontend/install_asset_structure/templates/manifest.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/lib/generators/netzplan_micro_frontend/install_asset_structure/templates/pack.coffee

@@ -0,0 +1,9 @@
+require("models")
+require("views")
+require("mapbox_styles")
+
+window.__micro_frontend_registry ||= {}
+
+# Import available micro_frontend Manager here:
+
+# Register available micro_frontend Manager here:

data/lib/generators/netzplan_micro_frontend/install_file_types/install_file_types_generator.rb

@@ -0,0 +1,48 @@
+module NetzplanMicroFrontend
+  module Generators
+    class InstallFileTypesGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def add_yarn_dependencies
+        inject_into_file 'package.json', after: "  \"dependencies\": {\n" do
+<<-'JAVASCRIPT'
+    "coffee-loader": "^0.9.0",
+    "coffeescript": "1.12.7",
+    "ejs-webpack-loader": "^2.2.2",
+    "backbone": "^1.4.0",
+    "jquery": "^3.4.1",
+JAVASCRIPT
+        end
+      end
+
+      def install_ejs
+        copy_file "ejs_loader.js", "config/webpack/loaders/ejs.js"
+
+        inject_into_file 'config/webpack/environment.js', after: "const { environment } = require('@rails/webpacker')\n" do
+<<-'JAVASCRIPT'
+const ejs = require('./loaders/ejs')
+environment.loaders.prepend('ejs', ejs)
+
+JAVASCRIPT
+        end
+      end
+
+      def install_coffeescript
+        copy_file "coffee_loader.js", "config/webpack/loaders/coffee.js"
+        inject_into_file 'config/webpacker.yml', after: "  extensions:\n" do
+<<-'YAML'
+    - .coffee
+YAML
+        end
+
+        inject_into_file 'config/webpack/environment.js', after: "const { environment } = require('@rails/webpacker')\n" do
+<<-'JAVASCRIPT'
+const coffee = require('./loaders/coffee')
+environment.loaders.prepend('coffee', coffee)
+
+JAVASCRIPT
+        end
+      end
+    end
+  end
+end

data/lib/generators/netzplan_micro_frontend/install_file_types/templates/coffee_loader.js

@@ -0,0 +1,6 @@
+module.exports = {
+  test: /\.coffee(\.erb)?$/,
+  use: [{
+    loader: 'coffee-loader'
+  }]
+}

data/lib/generators/netzplan_micro_frontend/install_file_types/templates/ejs_loader.js

@@ -0,0 +1,6 @@
+module.exports = {
+  test: /\.ejs$/,
+  use: [{
+    loader: "ejs-webpack-loader"
+  }]
+}

data/lib/generators/netzplan_micro_frontend/install_user_rights/install_user_rights_generator.rb

@@ -0,0 +1,19 @@
+module NetzplanMicroFrontend
+  module Generators
+    class InstallUserRightsGenerator < ::Rails::Generators::Base
+      def routes
+        route "use_netzplan_microfrontend"
+      end
+
+      def public_micro_frontend_sources
+        inject_into_file 'app/models/ability.rb', after: "def initialize(user)\n" do
+<<-'RUBY'
+    can :read, :micro_frontend_sources
+    can :manage, :micro_frontend
+
+RUBY
+        end
+      end
+    end
+  end
+end

data/lib/netzplan_micro_frontend.rb

@@ -0,0 +1,8 @@
+require "netzplan_micro_frontend/railtie"
+
+require "netzplan_micro_frontend/engine"
+require "netzplan_micro_frontend/rails/routes"
+
+module NetzplanMicroFrontend
+  # Your code goes here...
+end

data/lib/netzplan_micro_frontend/engine.rb

@@ -0,0 +1,7 @@
+module NetzplanMicroFrontend
+  class Engine < Rails::Engine
+    initializer "netzplan_micro_frontend.routes" do
+      NetzplanMicroFrontend::Rails::Routes.install!
+    end
+  end
+end

data/lib/netzplan_micro_frontend/rails/routes.rb

@@ -0,0 +1,16 @@
+module NetzplanMicroFrontend
+  module Rails
+    class Routes
+      module Helper
+        def use_netzplan_microfrontend(options = {}, &block)
+          get '/micro_frontend/debug' => 'netzplan_micro_frontend/debug#index', :as => :micro_frontend_debug
+          get '/micro_frontend/sources' => 'netzplan_micro_frontend/sources#index', :as => :micro_frontend_sources
+        end
+      end
+
+      def self.install!
+        ActionDispatch::Routing::Mapper.send :include, NetzplanMicroFrontend::Rails::Routes::Helper
+      end
+    end
+  end
+end

data/lib/netzplan_micro_frontend/railtie.rb

@@ -0,0 +1,4 @@
+module NetzplanMicroFrontend
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/netzplan_micro_frontend/version.rb

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

data/lib/tasks/netzplan_micro_frontend_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :netzplan_micro_frontend do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: netzplan_micro_frontend
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- René Meye
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Description of NetzplanMicroFrontend.
+email:
+- rene.meye@vesputi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/netzplan_micro_frontend/debug_controller.rb
+- app/controllers/netzplan_micro_frontend/sources_controller.rb
+- app/views/netzplan_micro_frontend/debug/index.html.erb
+- app/views/netzplan_micro_frontend/sources/index.json.jbuilder
+- lib/generators/netzplan_micro_frontend/install/install_generator.rb
+- lib/generators/netzplan_micro_frontend/install_asset_structure/install_asset_structure_generator.rb
+- lib/generators/netzplan_micro_frontend/install_asset_structure/templates/index_mapbox_styles.coffee
+- lib/generators/netzplan_micro_frontend/install_asset_structure/templates/index_models.js
+- lib/generators/netzplan_micro_frontend/install_asset_structure/templates/index_views.coffee
+- lib/generators/netzplan_micro_frontend/install_asset_structure/templates/manifest.css
+- lib/generators/netzplan_micro_frontend/install_asset_structure/templates/pack.coffee
+- lib/generators/netzplan_micro_frontend/install_file_types/install_file_types_generator.rb
+- lib/generators/netzplan_micro_frontend/install_file_types/templates/coffee_loader.js
+- lib/generators/netzplan_micro_frontend/install_file_types/templates/ejs_loader.js
+- lib/generators/netzplan_micro_frontend/install_user_rights/install_user_rights_generator.rb
+- lib/netzplan_micro_frontend.rb
+- lib/netzplan_micro_frontend/engine.rb
+- lib/netzplan_micro_frontend/rails/routes.rb
+- lib/netzplan_micro_frontend/railtie.rb
+- lib/netzplan_micro_frontend/version.rb
+- lib/tasks/netzplan_micro_frontend_tasks.rake
+homepage: https://www.vesputi.com/
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Summary of NetzplanMicroFrontend.
+test_files: []