isomorfeus-installer 1.0.0.delta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '087e024f4b6d1069db99cc60efe18ead0cd13d51aba1b1106feec8b1e10d64d8'
+  data.tar.gz: 89705b30c3d7c48147d8ca90e72e7966d02f2d9a2e343e01ffb59706beb7b2cc
+SHA512:
+  metadata.gz: b2d60cf511dcd98ff2a3cb88301f0f2b0eeb926a54e2bf75d004d6629868dedb8cf80976adeb4db2e857fc029057ccb205a9ce12d76798cc581901d6fea8af26
+  data.tar.gz: 2d157a5b142433859517feb5c3e962216cbaa3336965049617f02d943fdf7419d7cbdde4d912945e41e0085497a82e95f9e2281e6d23a096d70bfb0053043d8c

data/bin/isomorfeus

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'erb'
+require 'active_support/core_ext/string'
+
+require_relative '../lib/isomorfeus/installer'
+
+Isomorfeus::Installer.module_directories.each do |mod_dir|
+  mod_path = File.realpath(File.join(Isomorfeus::Installer.base_path, mod_dir))
+  modules = Dir.glob('*.rb', base: mod_path)
+  modules.each do |mod|
+    require_relative File.join(mod_path, mod)
+  end
+end
+
+options = {}
+sorted_frameworks = Isomorfeus::Installer.frameworks.keys.sort
+sorted_asset_bundlers = Isomorfeus::Installer.asset_bundlers.keys
+sorted_databases = Isomorfeus::Installer.databases.keys.sort
+sorted_transports = Isomorfeus::Installer.transports.keys
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: isomorfeus options...'
+  opts.separator ''
+  opts.separator 'Required:'
+  opts.on('-nNAME', '--new=NAME', String, "Create new project with NAME and install isomorfeus.") do |v|
+    options[:new] = v
+  end
+  # opts.on('-e', '--existing', "Install Isomorfeus into existing project.") do |v|
+  #  options[:existing] = v
+  # end
+  opts.separator ''
+  opts.separator 'Also required in any case is:'
+  opts.on('-fNAME', '--framework=FRAMEWORK', String, :REQUIRED, "Select base Framework, one of: #{sorted_frameworks.join(', ')}.") do |v|
+    if sorted_frameworks.include?(v)
+      options[:framework] = v
+      Isomorfeus::Installer.framework = Isomorfeus::Installer.frameworks[v]&.fetch(:installer)
+    else
+      puts "Framework #{v} not available!"
+      exit 1
+    end
+  end
+  opts.separator ''
+  opts.separator 'Other options:'
+  opts.on('-aBUNDLER', '--asset-bundler=BUNDLER', String, "Select asset bundler, one of: #{sorted_asset_bundlers.join(', ')}. (optional)") do |v|
+    if sorted_asset_bundlers.include?(v)
+      options[:asset_bundler] = v
+      Isomorfeus::Installer.asset_bundler = Isomorfeus::Installer.asset_bundlers[v]&.fetch(:installer)
+    else
+      puts "Asset bundler #{v} not available!"
+      exit 1
+    end
+  end
+  # opts.on('-dDATABASE', '--database=DATABASE', String, "Select database, one of: #{sorted_databases.join(', ')}. (optional, default: none)") do |v|
+  #   if sorted_frameworks.include?(v)
+  #     options[:database] = v
+  #   else
+  #     puts "Database #{v} not available!"
+  #     exit 1
+  #   end
+  # end
+  # opts.on('-tTRANSPORT', '--transport=TRANSPORT', String, "Select transport, one of: #{sorted_transports.join(', ')}. (optional, default: actioncable)") do |v|
+  #   if sorted_frameworks.include?(v)
+  #     options[:database] = v
+  #   else
+  #     puts "Database #{v} not available!"
+  #     exit 1
+  #   end
+  # end
+
+  opts.separator ''
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+Isomorfeus::Installer.options = options
+Isomorfeus::Installer.structure= Isomorfeus::Installer.frameworks[options[:framework]][:structure]
+
+if options[:new] && options[:existing]
+  puts "Either choose a new installation (-n), or installation into a existing project (-e), both won't work!"
+end
+if !options[:new] && !options[:existing]
+  puts "Don't know what to do! Either choose a new installation (-n), or installation into a existing project (-e)."
+end
+
+if options[:new]
+  begin
+    if Isomorfeus::Installer.framework.respond_to?(:create_project)
+      Isomorfeus::Installer.framework.create_project(options[:new])
+    else
+      Dir.mkdir(options[:new])
+    end
+    Dir.chdir(options[:new])
+  rescue
+    puts "Directory #{options[:new]} could not be created!"
+    exit 1
+  end
+end
+
+root = Dir.open('.')
+
+begin
+  Isomorfeus::Installer.create_directories
+  Isomorfeus::Installer.framework.install(root)
+  Isomorfeus::Installer.asset_bundler&.install(root)
+
+  camelized_dir = if options[:new]
+                    options[:new].camelize
+                  else
+                    File.split(File.realpath(Dir.new('.'))).last.camelize
+                  end
+
+  app_name = camelized_dir + 'App'
+  component_name = camelized_dir + 'Component'
+
+  Isomorfeus::Installer.create_loader(app_name)
+  Isomorfeus::Installer.create_toplevel(app_name, component_name)
+  Isomorfeus::Installer.create_component(component_name)
+
+  Isomorfeus::Installer.create_entrypoint
+  Isomorfeus::Installer.create_package_json
+  Isomorfeus::Installer.create_gemfile(Isomorfeus::Installer.frameworks[options[:framework]][:gems],
+                                       Isomorfeus::Installer.asset_bundlers[options[:asset_bundler]]&.fetch(:gems))
+  Isomorfeus::Installer.create_procfile
+
+  puts 'Installation finished, make your dreams come true :)'
+  puts
+  puts 'But first execute in the project directory:'
+  puts 'bundle install'
+  puts 'yarn install (or npm install)'
+rescue Exception => e
+  puts e.backtrace.join("\n")
+  puts "Installation failed: #{e.message}"
+end

data/isomorfeus-installer.gemspec

@@ -0,0 +1,19 @@
+require '../version.rb'
+
+Gem::Specification.new do |s|
+  s.name         = 'isomorfeus-installer'
+  s.version      = Isomorfeus::VERSION
+  s.author       = 'Jan Biedermann'
+  s.email        = 'jan@kursator.de'
+  s.homepage     = 'http://isomorfeus.com'
+  s.summary      = 'Create new isomorfeus-framework applications with ease.'
+  s.description  = 'Create new isomorfeus-framework applications with ease.'
+
+  s.bindir         = 'bin'
+  s.executables    << 'isomorfeus'
+  s.files          = `git ls-files`.split("\n")
+  s.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths  = ['lib']
+
+  s.add_runtime_dependency 'activesupport', '~> 5.0'
+end

data/lib/isomorfeus/installer.rb

@@ -0,0 +1,234 @@
+module Isomorfeus
+  module Installer
+
+    # driver support
+
+    def self.add_asset_bundler(name, props)
+      asset_bundlers[name] = props
+    end
+
+    def self.add_database(name, props)
+      databases[name] = props
+    end
+
+    def self.add_framework(name, props)
+      frameworks[name] = props
+    end
+
+    def self.add_transport(name, props)
+      transports[name] = props
+    end
+
+    def self.asset_bundler
+      @asset_bundler
+    end
+
+    def self.asset_bundler=(asset_b)
+      @asset_bundler = asset_b
+    end
+
+    def self.asset_bundlers
+      @asset_bundlers ||= {}
+    end
+
+    def self.databases
+      @databases ||= {}
+    end
+
+    def self.frameworks
+      @frameworks ||= {}
+    end
+
+    def self.framework
+      @framework
+    end
+
+    def self.framework=(frame_w)
+      @framework = frame_w
+    end
+
+    def self.transports
+      @transports ||= {}
+    end
+
+    def self.structure=(struct)
+      @structure = struct
+    end
+
+    def self.structure
+      @structure
+    end
+
+    # installer options and config
+
+    def self.options
+      @options
+    end
+
+    def self.options=(opts)
+      @options = opts
+    end
+
+    def self.module_directories
+      %w[asset_bundlers databases frameworks transports]
+    end
+
+    # installer paths
+    #
+    def self.base_path
+      @base_path ||= File.realpath(File.join(File.dirname(File.realpath(__FILE__)), 'installer'))
+    end
+
+    def self.templates_path
+      @templates_path ||= File.realpath(File.join(File.dirname(File.realpath(__FILE__)), 'installer', 'templates'))
+    end
+
+    # app paths
+
+    def self.asset_output_path
+      File.join('public', 'assets')
+    end
+
+    def self.entrypoint
+      'application.js'
+    end
+
+    def self.entrypoint_path
+      if structure == :app_iso
+        File.join('app', 'assets', 'javascripts', entrypoint)
+      else
+        File.join('assets', 'javascripts', entrypoint)
+      end
+    end
+
+    def self.isomorfeus_path
+      if structure == :app_iso
+        File.join('app', 'isomorfeus')
+      else
+        'isomorfeus'
+      end
+    end
+
+    def self.stylesheets_path
+      if structure == :app_iso
+        File.join('app', 'assets', 'stylesheets')
+      else
+        File.join('assets', 'stylesheets')
+      end
+    end
+
+    # install helpers
+
+    def self.create_directories
+      if structure == :app_iso
+        Dir.mkdir('config') unless Dir.exist?('config')
+        Dir.mkdir('app') unless Dir.exist?('app')
+        Dir.chdir('app')
+      end
+      Dir.mkdir('isomorfeus') unless Dir.exist?('isomorfeus')
+      Dir.chdir('isomorfeus')
+      Dir.mkdir('components') unless Dir.exist?('components')
+      if use_database?
+        Dir.mkdir('models') unless Dir.exist?('models')
+      end
+
+      Dir.chdir('..') if structure == :app_iso
+      Dir.chdir('..')
+
+      Dir.mkdir('public') unless Dir.exist?('public')
+      Dir.mkdir('public/assets') unless Dir.exist?('public/assets')
+      Dir.mkdir('assets') unless Dir.exist?('assets')
+      Dir.mkdir('assets/javascripts') unless Dir.exist?('assets/javascripts')
+      Dir.mkdir('assets/stylesheets') unless Dir.exist?('assets/stylesheets')
+    end
+
+    def self.create_file_from_template(template_path, target_file_path, data_hash)
+      template = ERB.new(File.read(File.join(templates_path, template_path), mode: 'r'))
+      result = template.result_with_hash(data_hash)
+      ext = File.exist?(target_file_path) ? '_new' : ''
+      File.write(target_file_path + ext, result, mode: 'w')
+    end
+
+    def self.create_entrypoint
+      data_hash = {}
+      create_file_from_template(entrypoint + '.erb', entrypoint_path, data_hash)
+    end
+
+    def self.create_gemfile(framework_gems, asset_bundler_gems)
+      asset_bundler_gems_result = ''
+      asset_bundler_gems.each { |gem| asset_bundler_gems_result << "gem '#{gem[:name]}', '#{gem[:version]}'\n" } if asset_bundler_gems
+      if framework_gems == :has_gemfile
+        framework_gems_result = File.read('Gemfile')
+        File.delete('Gemfile')
+        data_hash = { asset_bundler_gems: asset_bundler_gems_result,
+                      framework_gems: framework_gems_result,
+                      skip_header: true }
+      else
+        framework_gems_result = ''
+        framework_gems.each { |gem| framework_gems_result << "gem '#{gem[:name]}', '#{gem[:version]}'\n" }
+        data_hash = { asset_bundler_gems: asset_bundler_gems_result,
+                      framework_gems: framework_gems_result }
+      end
+      create_file_from_template('Gemfile.erb', 'Gemfile', data_hash)
+    end
+
+    def self.create_loader(app_name)
+      data_hash = { app_name: app_name }
+      iso_entry = File.join(isomorfeus_path, 'isomorfeus_loader.rb')
+      create_file_from_template('isomorfeus_loader.rb.erb', iso_entry, data_hash)
+    end
+
+    def self.create_package_json
+      npms = ''
+      if options.has_key?(:asset_bundler) && asset_bundlers[options[:asset_bundler]].has_key?(:npms)
+        asset_bundlers[options[:asset_bundler]][:npms].each do |npm|
+          npms << "\"#{npm[:name]}\": \"#{npm[:version]}\",\n"
+        end
+      end
+      data_hash = { application_name: options[:new],
+                    scripts: asset_bundler.respond_to?(:package_scripts) ? asset_bundler.package_scripts : '',
+                    npm_packages: npms }
+      create_file_from_template('package.json.erb', 'package.json', data_hash)
+    end
+
+    def self.create_procfile
+      data_hash = { framework_start_command: framework.start_command,
+                    asset_bundler_start_command: asset_bundler.start_command }
+      create_file_from_template('Procfile.erb', 'Procfile', data_hash)
+    end
+
+    def self.create_component(component_name)
+      data_hash = { component_name: component_name }
+      create_file_from_template('my_component.rb.erb',File.join(isomorfeus_path, 'components', component_name.underscore + '.rb'), data_hash)
+    end
+
+    def self.create_toplevel(app_name, component_name)
+      data_hash = { app_name: app_name, component_name: component_name }
+      create_file_from_template('my_app.rb.erb',File.join(isomorfeus_path, 'components', app_name.underscore + '.rb'), data_hash)
+    end
+
+    def self.create_requires
+      "require 'bundler/setup'\nBundler.require(:default)\n"
+    end
+
+    # def self.require_record?
+    #   @require_record
+    # end
+    #
+    # def self.require_operation?
+    #   @require_operation
+    # end
+    #
+    # def self.require_policy?
+    #   @require_policy
+    # end
+    #
+    # def self.require_spectre?
+    #   @require_spectre
+    # end
+
+    def self.use_database?
+      options.has_key?(:database) && options[:database] != 'none'
+    end
+  end
+end

data/lib/isomorfeus/installer/asset_bundlers/opal_webpack_loader.rb

@@ -0,0 +1,103 @@
+module Isomorfeus
+  module Installer
+    module AssetBundlers
+      module OpalWebpackLoader
+        TARGETS = %w[development.js production.js]
+
+        def self.start_command
+          'yarn run start'
+        end
+
+        def self.script_tag(path)
+          "owl_script_tag('#{path}')"
+        end
+
+        def self.package_scripts
+          <<~SCRIPTS
+          "scripts": {
+            "start": "bundle exec opal-webpack-compile-server start webpack-dev-server --config #{development_js_path}",
+            "build": "bundle exec opal-webpack-compile-server start webpack --config=#{production_js_path}"
+          },
+          SCRIPTS
+        end
+
+        def self.development_js_path
+          if Isomorfeus::Installer.structure == :app_iso
+            File.join('config', 'webpack', 'development.js')
+          else
+            'development.js'
+          end
+        end
+
+        def self.production_js_path
+          if Isomorfeus::Installer.structure == :app_iso
+            File.join('config', 'webpack', 'production.js')
+          else
+            'production.js'
+          end
+        end
+
+        def self.asset_bundler_config
+          <<~CONFIG
+          # OpalWebpackLoader.manifest_path = File.join( 'public', 'assets', 'manifest.json')
+          if ENV['PROJECT_ENV'] && ENV['PROJECT_ENV'] != 'development'
+            OpalWebpackLoader.client_asset_path = '' # the full path is in the manifest already, like: /packs/website_packs-97fd9c2b7e7bdb112fc1.js
+            OpalWebpackLoader.use_manifest = true
+          else
+            OpalWebpackLoader.client_asset_path = 'http://localhost:3035/assets/'
+            OpalWebpackLoader.use_manifest = false
+          end
+          CONFIG
+        end
+
+        def self.asset_bundler_includes(rails_style = false)
+          if rails_style
+            "include OpalWebpackLoader::RailsViewHelper"
+          else
+            "include OpalWebpackLoader::ViewHelper"
+          end
+        end
+
+        def self.install(root)
+          if Isomorfeus::Installer.structure == :iso
+            entrypoint_path = Isomorfeus::Installer.entrypoint_path
+            asset_output_path = Isomorfeus::Installer.asset_output_path
+            isomorfeus_path = Isomorfeus::Installer.isomorfeus_path
+            stylesheets_path = Isomorfeus::Installer.stylesheets_path
+          else
+            entrypoint_path = File.join('..', '..', Isomorfeus::Installer.entrypoint_path)
+            asset_output_path = File.join('..', '..', Isomorfeus::Installer.asset_output_path)
+            isomorfeus_path = File.join('..', '..', Isomorfeus::Installer.isomorfeus_path)
+            stylesheets_path = File.join('..', '..', Isomorfeus::Installer.stylesheets_path)
+          end
+
+          data_hash = { isomorfeus_path: isomorfeus_path,
+                        asset_output_path: asset_output_path,
+                        stylesheets_path: stylesheets_path,
+                        entrypoint_path: entrypoint_path}
+
+          if Isomorfeus::Installer.structure == :app_iso
+            Dir.mkdir('config') unless Dir.exist?('config')
+            Dir.mkdir(File.join('config','webpack')) unless Dir.exist?(File.join('config', 'webpack'))
+            TARGETS.each do |target|
+              Isomorfeus::Installer.create_file_from_template(File.join('owl', target + '.erb'),
+                                                              File.join('config', 'webpack', target), data_hash)
+            end
+          else
+            TARGETS.each do |target_path|
+              Isomorfeus::Installer.create_file_from_template(File.join('owl', target_path + '.erb'),
+                                                              target_path, data_hash)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+Isomorfeus::Installer.add_asset_bundler('owl', {
+  gems: [ { name: 'opal-webpack-loader', version: '~> 0.5.0' } ],
+  npms: [ { name: 'opal-webpack-loader', version: '^0.5.0' } ],
+  installer: Isomorfeus::Installer::AssetBundlers::OpalWebpackLoader,
+  structure: :iso
+})