rails2lb4 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17a1f0ccbd6c81c97d997cba4184988c8a6932b50091bd6ce5d4123621159258
+  data.tar.gz: 23f60cfdffac43b3fa4e23e63db2096e4b3761556521c861c5a82ef863a37776
+SHA512:
+  metadata.gz: 803ccfbdb19c79a9f07dc07975fb215bbaaa3044b7c682f9efdc126e4ef3d1a95653a9a9b8cf58165f5f4f4185a619f8ec7ce9941c51fa533359f3778b8b11f6
+  data.tar.gz: 26175cd91f0588e6728a0af73284e46f4157250b5d26ec24a080d8e7814e91b7e0f8056d13d1fbc2df922beb7174a7db62067c3ca5003a509c446b05f101fe50

data/LICENSE

@@ -0,0 +1,19 @@
+MIT license
+
+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,68 @@
+**Warning**: this application is only demo quality at the moment.  Do not use on
+an existing loopback4 appication is not under version control where all of the
+changes have already been committed as this application may overwrite files.
+
+This tool will create a loopback4 model, respository, and datasource based on
+an existing Rails application.
+
+Step 0
+------
+
+Install `rails` and/or `loopback4` if they are not already installed:
+
+    gem install rails
+    npm install -g loopback-cli
+    
+Note: in order to install these tools, you need to have previously installed `ruby`, `node`, `npm` and other tools.  Check the installation instructions for
+[rails](https://guides.rubyonrails.org/getting_started.html#installing-rails) and
+[loopback4](https://loopback.io/doc/en/lb4/Getting-started.html) for details.
+
+Step 1
+------
+
+Install this tool:
+
+    gem install rails2lb4
+
+Step 2
+------
+
+Locate a Rails application.  If you don't already have one, you can follow the [Creating the Blog Application](https://guides.rubyonrails.org/getting_started.html#creating-the-blog-application) in the Rails guide, or
+clone it from [https://github.com/rubys/railsguide_blog](https://github.com/rubys/railsguide_blog.git).
+
+Step 3
+------
+
+Locate or create a new loopback application.  To create a new application:
+
+    lb4 app blog
+    
+Step 4
+------
+
+Run the tool, specifying the path to the source rails and destination loopback applications:
+
+     rails2lb4 /path/to/rails/blog /path/to/loopback4/blog
+     
+Note: by default, this tool will set up the loopback application to access the Rails `development` database.  If you would like to access another database, set the `RAILS_ENV` environment variable before running this step.
+ 
+
+Step 5 (optional)
+-----------------
+
+Create REST controllers for the new models:
+
+    lb4 controller article
+    lb4 controller comment
+    
+Note: specify `number` as the type of `id` for these controllers.
+    
+Step 6 (optional)
+-----------------
+
+Start the loopback4 server:
+
+    npm start
+    
+Note: by default, both Rails and Loopback4 default to listen to port 3000.  Be sure to stop your Rails server before starting your loopback4 server.
+

data/bin/rails2lb4

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+source = target = Dir.pwd
+
+if ARGV.length == 2
+  source, target = ARGV
+elsif ARGV.length == 1
+  if File.exist? File.expand_path('Rakefile', ARGV.first)
+    source = File.expand_path(ARGV.first)
+  elsif File.exist? File.expand_path('index.ts', ARGV.first)
+    target = File.expand_path(ARGV.first)
+  end
+else
+  STDERR.puts "Usage: #{$0} [source] [target]"
+  exit 1
+end
+
+unless File.exist? File.expand_path('Rakefile', source)
+  STDERR.puts 'source directory is not a Rails app'
+  exit 1
+end
+
+unless File.exist? File.expand_path('index.ts', target)
+  STDERR.puts 'target directory is not a lb4  app'
+  exit 1
+end
+
+require 'rails2lb4'
+
+rails2lb4 source, target

data/lib/rails2lb4.rb

@@ -0,0 +1,137 @@
+require 'erubis'
+require 'ansi'
+require 'yaml'
+require 'json'
+
+require 'active_support/core_ext/string'
+require 'active_support/inflector'
+
+def rails2lb4(source, target)
+  # import custom pluralization
+  if File.exist? "#{source}/config/initializers/inflections.rb"
+    require "#{source}/config/initializers/inflections.rb"
+  end
+
+  # define a write operation that colorizes output and determines if the
+  # output represent new content or a change.
+  def target.write path, contents
+    dest = File.join(self, path)
+    if File.size?(dest) and IO.read(dest) == contents
+      puts ANSI.blue { 'skipping ' } + path
+    else
+      if File.size?(dest)
+	puts ANSI.bold { ANSI.magenta { 'updating ' } } + path
+      else
+	puts ANSI.bold { ANSI.green { 'creating ' } } + path
+      end
+      IO.write dest, contents
+    end
+  end
+
+  # determine the database type from the configuration
+  environment = ENV['RAILS_ENV'] || 'development'
+  database = YAML.load_file("#{source}/config/database.yml")
+  @adapter = database[environment]['adapter']
+
+  # common configuration
+  config = {
+    name: @adapter,
+    connector: "loopback-connector-#{@adapter}"
+  }
+
+  # database specific configuration
+  if @adapter == 'sqlite3'
+    config[:file] = File.expand_path(database[environment]['database'], source)
+
+    Dir.chdir target do
+      unless IO.read('package.json').include? 'loopback-connector-sqlite3'
+	system 'npm install loopback-connector-sqlite3 --save'
+      end
+    end
+
+  elsif @adapter == 'mysql' or @adapter == 'postgresql'
+    environment = database[environment]
+    %w(database host password.port username).each do |property|
+      config[property] = environment[property] if environment[property]
+    end
+
+    if @adapter == 'mysql'
+      config[:socketPath] = environtment[:socket] if environment[:socket]
+      config[:connectionLimit] = environtment[:pool] if environment[:pool]
+    end
+  end
+
+  # produce datasource.ts
+  template = File.read(File.join(__dir__, '../templates/datasource.erb'))
+  datasource = Erubis::Eruby.new(template).result(binding)
+  path = File.join('src', 'datasources', "#{@adapter}.datasource.ts")
+  target.write path, datasource
+
+  # produce datasource.json
+  path = File.join('src', 'datasources', "#{@adapter}.datasource.json")
+  target.write path, JSON.pretty_generate(config)
+
+  # produce datasource/index.ts
+  index = Dir["#{target}/src/datasources/*.datasource.ts"].sort.
+    map {|file| "export * from './#{File.basename(file, '.ts')}';"}.
+    join("\n") + "\n"
+  target.write 'src/datasources/index.ts', index
+
+  # parse schema.rb from the source
+  schema = IO.read("#{source}/db/schema.rb")
+  table = /^\s+create_table "([^"]+)",.*?\n(.*?)\n\s+end/m
+
+  data_types = {
+    "integer" => "number",
+    "float" => "number",
+    "text" => "string",
+    "boolean" => "boolean",
+    "date" => "Date",
+    "datetime" => "Date",
+  }
+
+  tables = {}
+  schema.scan(table).each do |name, ddl|
+    cols = ddl.scan(/^\s+t\.(\w+)\s+"(\w+)/).
+      map {|names| [names.last, data_types[names.first] || names.first]}.to_h
+    tables[name] = cols
+  end
+
+  # produce model.ts and repository.ts for each model
+  Dir["#{source}/app/models/*.rb"].sort.each do |file|
+    model = File.read(file)
+    basename = File.basename(file, '.rb')
+    @table = tables[basename.pluralize] || {}
+    @class_name = model[/class (\w+)/, 1]
+    @table_name = @class_name.downcase.pluralize
+
+    @belongs_to = model.scan(/^\s+belongs_to\s*:(\w+)/).
+      map {|(name)| [name, name.camelcase]}.to_h
+    @has_many = model.scan(/^\s+has_many\s*:(\w+)/).
+      map {|(name)| [name.singularize, name.singularize.camelcase]}.to_h
+
+    template = File.read(File.join(__dir__, '../templates/model.erb'))
+    model = Erubis::Eruby.new(template).result(binding)
+
+    path = File.join('src', 'models', basename+'.model.ts')
+    target.write path, model
+
+    template = File.read(File.join(__dir__, '../templates/repository.erb'))
+    repository = Erubis::Eruby.new(template).result(binding)
+
+    path = File.join('src', 'repositories', basename+'.repository.ts')
+    target.write path, repository
+  end
+
+  # produce model.index.ts
+  index = Dir["#{target}/src/models/*.model.ts"].sort.
+    map {|file| "export * from './#{File.basename(file, '.ts')}';"}.
+    join("\n") + "\n"
+  target.write 'src/models/index.ts', index
+
+  # produce repositories.index.ts
+  index = Dir["#{target}/src/repositories/*.repository.ts"].sort.
+    map {|file| "export * from './#{File.basename(file, '.ts')}';"}.
+    join("\n") + "\n"
+  target.write 'src/repositories/index.ts', index
+end

data/templates/datasource.erb

@@ -0,0 +1,14 @@
+import {inject} from '@loopback/core';
+import {juggler} from '@loopback/repository';
+import * as config from './<%= @adapter %>.datasource.json';
+
+export class Sqlite3DataSource extends juggler.DataSource {
+  static dataSourceName = '<%= @adapter %>';
+
+  constructor(
+    @inject('datasources.config.<%= @adapter %>', {optional: true})
+    dsConfig: object = config,
+  ) {
+    super(dsConfig);
+  }
+}

data/templates/model.erb

@@ -0,0 +1,42 @@
+<% 
+  imports = %w{Entity property model}
+  imports << 'belongsTo' unless @belongs_to.empty?
+  imports << 'hasMany' unless @has_many.empty?
+%>
+import {<%= imports.join(', ') %>} from '@loopback/repository';
+<% @belongs_to.merge(@has_many).each do |name, value| %>
+import {<%= value %>} from './<%= name %>.model';
+<% end %>
+
+@model({settings: {<%= @adapter %>: {table: '<%= @table_name %>'}}})
+export class <%= @class_name %> extends Entity {
+  @property({
+    type: 'number',
+    id: true
+  })
+  id: number;
+  <% @table.each do |attr, value| %>
+
+  <% if @belongs_to.keys.any? {|key| "#{key}_id" == attr} %>
+  @belongsTo(() => <%= @belongs_to[attr.sub(/_id/, '')] %>, {keyTo: 'id'})
+  <% else %>
+  @property({
+    type: '<%= value %>'
+  })
+  <% end %>
+  <%= attr %>: <%= value %>;
+  <% end %>
+  <% @has_many.each do |name, value| %>
+
+  @hasMany(() => <%= value %>, {keyTo: '<%= @class_name.downcase %>_id'})
+  <%= name.pluralize %>: <%= value %>[];
+  <% end %>
+
+  getId() {
+    return this.id;
+  }
+
+  constructor(data?: Partial<<%= @class_name %>>) {
+    super(data);
+  }
+}

data/templates/repository.erb

@@ -0,0 +1,15 @@
+import {DefaultCrudRepository, juggler} from '@loopback/repository';
+import {<%= @class_name %>} from '../models';
+import {Sqlite3DataSource} from '../datasources';
+import {inject} from '@loopback/core';
+
+export class <%= @class_name %>Repository extends DefaultCrudRepository<
+  <%= @class_name %>, 
+  typeof <%= @class_name %>.prototype.id
+> {      
+  constructor(
+    @inject('datasources.sqlite3') dataSource: Sqlite3DataSource,
+  ) {        
+    super(<%= @class_name %>, dataSource);
+  } 
+} 

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rails2lb4
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sam Ruby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Builds a loopback4 datasource, model, and repository from Rails schema.rb,
+  database.yml, and model sources
+email:
+- rubys@intertwingly.net
+executables:
+- rails2lb4
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/rails2lb4
+- lib/rails2lb4.rb
+- templates/datasource.erb
+- templates/model.erb
+- templates/repository.erb
+homepage: http://github.com/rubys/rails2lb4
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Convert Rails model to loopback4
+test_files: []