inscriber 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25cd71662f1327ab02f6eaac583c1ae8727e0036
+  data.tar.gz: a03f95e61cda151ca45875d2d606830ef9c91097
+SHA512:
+  metadata.gz: aa1a6431171baa7fb49b6809f31d8491ab9ac74e034638eb446ab3d91647b2b9aa5dcf0d4e416c5005c76ff41e3f5cbbc83f46e6a2629730e785a9a96b303c80
+  data.tar.gz: 53d2a1fcd1fd1183eb872bb8e9c28e5fa7756a18bf2a38eb025080ab3863588bd9e5e33472b9ff6ab8cf9cc6d984e18ae77f1495879b18bce153edebb15d3e15

data/lib/inscriber/config.rb

@@ -0,0 +1,25 @@
+require 'yaml'
+
+module Inscriber
+  class Config
+    class << self
+      def data
+        path = ENV['INSCRIBER_CONFIG'] || 'config/inscriber.yml' 
+        @data = symbolize_all_keys(YAML.load_file(path))
+      end
+
+      private
+
+      def symbolize_all_keys(obj)
+        case obj
+        when Hash 
+          obj.each_with_object({}){ |(k,v), h| h[k.to_sym] = symbolize_all_keys(v) }
+        when Array
+          obj.map{ |elem| symbolize_all_keys(elem) }
+        else
+          obj 
+        end
+      end
+    end
+  end
+end

data/lib/inscriber/connection_string.rb

@@ -0,0 +1,17 @@
+require 'sequel'
+
+module Inscriber
+  class ConnectionString
+    ADAPTER_STRINGS = { 
+      mysql: "%{adapter}://%{username}:%{password}@%{host}/%{database_name}",
+      postgres: "%{adapter}://%{username}:%{password}@%{host}/%{database_name}",
+      sqlite: "%{adapter}://%{database_name}"
+    }
+
+    class << self
+      def generate(options)
+        ADAPTER_STRINGS[options[:adapter].to_sym] % options
+      end
+    end
+  end
+end

data/lib/inscriber/database.rb

@@ -0,0 +1,38 @@
+module Inscriber
+  class Database
+    attr_accessor :adapter, :host, :port, :username, :password, :source_lang
+    attr_accessor :output_dir, :input_dir, :file_name, :tables, :locales, :database_name
+
+    DEFAULT_HOST = '127.0.0.1'
+    DEFAULT_PORT = 5432
+
+    def initialize(options={})
+      @adapter       = options.fetch(:adapter, nil)
+      @host          = options.fetch(:host, DEFAULT_HOST)
+      @port          = options.fetch(:port, DEFAULT_PORT)
+      @database_name = options.fetch(:database_name, nil)
+      @username      = options.fetch(:username, '')
+      @password      = options.fetch(:password, '')
+      @source_lang   = options.fetch(:source_lang, 'en')
+      @output_dir    = options.fetch(:output_dir, '.')
+      @input_dir     = options.fetch(:input_dir, @output_dir)
+      @file_name     = options.fetch(:file_name, 'translations')
+      @tables        = options.fetch(:tables, nil)
+      @locales       = options.fetch(:locales, nil)
+    end
+
+    def connection
+      @connection ||= Sequel.connect(connection_string)
+    end
+
+    private
+
+    def connection_string
+      Inscriber::ConnectionString.generate(connection_opts)
+    end
+
+    def connection_opts
+      { adapter: adapter, host: host, port: port, database_name: database_name, username: username, password: password }
+    end
+  end
+end

data/lib/inscriber/downloader.rb

@@ -0,0 +1,41 @@
+module Inscriber
+  class Downloader
+    include TableHelpers
+
+    def initialize(database)
+      @db          ||= connect_to_db(database)
+      @database    = database
+      @result_hash = Hash.new(0)
+    end
+
+    def download
+      @database.tables.each do |table|
+        record_hash = Hash.new(0)
+        records = records_from_table(table[:name]).all
+        unless records.empty?
+          records.each do |record|
+            record_hash[record[:id]] = generate_hash_from_record(record, table)
+          end
+          @result_hash[table[:name]] = record_hash
+        end
+      end
+      @result_hash
+    end
+
+    private 
+
+    def connect_to_db(database)
+      database.connection
+    end
+
+    def records_from_table(table_name)
+      @db.from(table_name).where(locale: @database.source_lang)
+    end
+
+    def generate_hash_from_record(record, table)
+      record.select{ |k,v| table[:columns].include? k.to_s }
+        .merge(original_column_name(table[:name]).to_s => record[original_column_name(table[:name])])
+        .inject({}){ |h, (k,v)| h[k.to_s] = v; h }.to_h
+    end
+  end
+end

data/lib/inscriber/exporter.rb

@@ -0,0 +1,17 @@
+module Inscriber
+  class Exporter
+    class << self
+      def export(database)
+        data = { "#{database.source_lang}" => download_from_db(database) }
+        File.open("#{database.output_dir}/#{database.file_name}.yml", "w") { |f| f.write data.to_yaml }
+        { status: true }
+      end
+      
+      private
+
+      def download_from_db(database)
+        Inscriber::Downloader.new(database).download
+      end
+    end
+  end
+end

data/lib/inscriber/inserter.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+
+module Inscriber
+  class Inserter
+    class << self
+      def insert(database)
+        database.locales.each do |locale|
+          file_path = "#{database.input_dir}/#{database.file_name}"
+          if File.exist? "#{file_path}.#{locale}.yml"
+            data          = YAML.load_file("#{file_path}.#{locale}.yml")
+            source_data   = YAML.load_file("#{file_path}.yml")
+            records_array = []
+
+            data[locale].each do |table, records|
+              records.each do |k,v|
+                records_array << source_data[database.source_lang][table][k].merge(v)
+              end
+              opts = { database: database, table: table, records: records_array, locale: locale }
+              upload_data_to_db(opts)
+            end
+          else
+            { status: false, error: 'File not found' }
+          end
+        end
+        { status: true } 
+      end
+
+      private
+
+      def upload_data_to_db(opts)
+        Inscriber::Uploader.new(opts).upload
+      end
+    end
+  end
+end

data/lib/inscriber/table_helper.rb

@@ -0,0 +1,11 @@
+module Inscriber
+  module TableHelpers
+    def original_table_name(table_name)
+      table_name.sub(/_translations\z/, '')
+    end
+
+    def original_column_name(table_name)
+      "#{original_table_name(table_name)}_id".to_sym
+    end
+  end
+end

data/lib/inscriber/uploader.rb

@@ -0,0 +1,59 @@
+module Inscriber
+  class Uploader
+    include TableHelpers
+    attr_accessor :database, :table, :records, :locale
+
+    def initialize(opts)
+      @database = opts[:database]
+      @table    = opts[:table]
+      @records  = opts[:records]
+      @locale   = opts[:locale]
+    end
+
+    def upload
+      records.each do |record|
+        update_or_create_record(record)
+      end
+    end
+
+    private
+
+    def db_connection
+      @db ||= database.connection
+    end
+
+    def db_from_table
+      db_connection.from(table)
+    end
+
+    def original_column
+      original_column_name(table)
+    end
+
+    def update_or_create_record(record)
+      row = db_from_table.where(
+        original_column => record[original_column.to_s],
+        :locale => locale) 
+
+      if row.empty?
+        db_from_table.insert({
+          locale: locale}
+          .merge(created_at)
+          .merge(updated_at)
+          .merge(record))
+      else
+        row.update(record)
+      end
+    end
+
+    def created_at
+      return {} unless db_from_table.columns.include?(:created_at)
+      { created_at: Time.now }
+    end
+
+    def updated_at 
+      return {} unless db_from_table.columns.include?(:updated_at)
+      { updated_at: Time.now }
+    end
+  end
+end

data/lib/inscriber/version.rb

@@ -0,0 +1,3 @@
+module Inscriber
+  VERSION = '0.0.1'
+end

data/lib/inscriber.rb

@@ -0,0 +1,32 @@
+require 'inscriber/config'
+require 'inscriber/connection_string'
+require 'inscriber/database'
+require 'inscriber/table_helper'
+require 'inscriber/downloader'
+require 'inscriber/uploader'
+require 'inscriber/exporter'
+require 'inscriber/inserter'
+
+module Inscriber
+  class << self
+    def export 
+      begin
+        @config ||= Inscriber::Config.data
+        @database ||= Inscriber::Database.new(@config)
+        Inscriber::Exporter.export(@database)
+      rescue => e
+        { status: false, error: e }
+      end
+    end
+
+    def insert
+      begin
+        @config ||= Inscriber::Config.data
+        @database ||= Inscriber::Database.new(@config)
+        Inscriber::Inserter.insert(@database)
+      rescue => e
+        { status: false, error: e }
+      end
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'spec_helpers/test_database'
+require 'spec_helpers/config_helpers'
+require 'tempfile'
+require 'yaml'
+
+describe Inscriber::Config do
+  let!(:file) do
+    file = Tempfile.new('inscriber.yml')
+    file.write(YAML.dump(Inscriber::ConfigHelpers.config))
+    file.rewind
+    file
+  end
+
+  let!(:data) do
+    ENV['INSCRIBER_CONFIG'] = "#{file.path}"
+    Inscriber::Config.data
+  end
+
+  describe '.data' do
+    it 'loads object from inscriber.yml' do
+      expect(data[:adapter]).to eq('sqlite')  
+      expect(data[:host]).to eq('localhost')  
+      expect(data[:database_name]).to eq('test.sqlite')
+      file.close
+      file.unlink
+    end
+  end
+end

data/spec/connection_string_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Inscriber::ConnectionString do
+  let!(:config) { Inscriber::ConfigHelpers.config }
+  describe '.generate' do
+    it 'returns mysql string when mysql adapter' do
+      config[:adapter] = 'mysql'
+      expect(Inscriber::ConnectionString.generate(config)).to be_a String
+    end
+    it 'returns postgres string when postgres adapter' do
+      config[:adapter] = 'postgres'
+      expect(Inscriber::ConnectionString.generate(config)).to be_a String
+    end
+    it 'returns sqlite string when sqlite adapter' do
+      config[:adapter] = 'sqlite'
+      expect(Inscriber::ConnectionString.generate(config)).to be_a String
+    end
+  end
+end

data/spec/database_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'spec_helpers/test_database'
+
+describe Inscriber::Database do
+  let!(:database) { Inscriber::TestDatabase.setup }
+
+  describe '.connection' do
+    it 'should return a connection to a db' do
+      expect(database.connection).to be_a(Sequel::SQLite::Database)
+    end
+  end
+end

data/spec/downloader_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'pry'
+
+describe Inscriber::Downloader do
+  let!(:database) do
+    Inscriber::TestDatabase.setup do
+      create_table :test_translations do
+        primary_key :id
+        integer :test_id
+        string :body
+        string :locale
+      end
+    end
+  end
+
+  describe '.download' do
+    it 'should download a hash of the data in the db' do
+      database.connection.from(:test_translations).insert(:body => 'test string', :test_id => 1, :locale => 'en')
+      download = Inscriber::Downloader.new(database).download
+
+      expect(download.keys).to include 'test_translations'
+      expect(download['test_translations'].values.first["body"]).to eq 'test string'
+      expect(download['test_translations'].values.first["test_id"]).to eq 1
+    end
+  end
+end

data/spec/exporter_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Inscriber::Exporter do
+  let!(:database) do
+    Inscriber::TestDatabase.setup do
+      create_table :test_translations do
+        primary_key :id
+        integer :test_id
+        string :body
+        string :locale
+      end
+    end
+  end
+
+  let :file do
+    database.connection.from(:test_translations).insert(:body => 'test string', :test_id => 1, :locale => 'en')
+    Inscriber::Exporter.export(database)
+    "#{database.file_name}.yml"
+  end
+
+  describe '.export' do
+    let!(:data) { YAML.load_file(file) }
+
+    it 'should create a yml file from the downloaded data' do
+      expect(File).to exist(file) 
+    end
+
+    it 'should have the data in the yml file' do
+      expect(data.has_key? "en").to be true
+      expect(data["en"].has_key? "test_translations").to be true
+      expect(data["en"]["test_translations"].values.first["body"]).to eq 'test string'
+      File.unlink(file)
+    end
+  end
+end

data/spec/inserter_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'spec_helpers/config_helpers'
+
+describe Inscriber::Inserter do
+  let!(:database) do
+    Inscriber::TestDatabase.setup do
+      create_table :test_translations do
+        primary_key :id
+        integer :test_id
+        string :body
+        string :locale
+      end
+    end
+  end
+
+  let!(:config) do
+    {
+      "fr" => {
+        "test_translations" => { 
+          1 => {
+            "body" => "Chaîne de test"
+          }
+        }
+      }
+    }
+  end
+
+  let! :file do
+    database.connection.from(:test_translations).insert(:body => 'test string', :test_id => 1, :locale => 'en')
+    Inscriber::Exporter.export(database)
+    "#{database.file_name}.yml"
+  end
+
+  let!(:translated_file) do
+    File.open('test.fr.yml', 'w') { |f| f.write config.to_yaml }
+  end
+
+  let(:db) do
+    database.connection.from(config["fr"].keys.first)
+  end
+
+  describe '.insert' do
+    it 'should read the yml file and insert the data into the db' do
+      Inscriber::Inserter.insert(database)
+      query = { 
+        :locale => config.keys.first, 
+        :body => config["fr"]["test_translations"].values.first["body"]
+      }
+      expect(db.where(query).all.length).to be 1
+      File.unlink('test.fr.yml')
+      File.unlink('test.yml')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'rspec'
+require 'sequel'
+require 'sqlite3'
+require 'inscriber'
+
+require 'spec_helpers/test_database'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Inscriber::TestDatabase.reset
+  end
+end

data/spec/spec_helpers/config_helpers.rb

@@ -0,0 +1,28 @@
+module Inscriber
+  class ConfigHelpers
+    class << self
+      def config
+        {
+          adapter: 'sqlite',
+          host: 'localhost',
+          database_name: 'test.sqlite',
+          username: '',
+          password: '',
+          source_lang: 'en',
+          file_name: 'test',
+          input_dir: '.',
+          output_dir: '.',
+          tables: [
+            {
+              name: 'test_translations',
+              columns: ['body']
+            }
+          ],
+          locales: [
+            'fr'
+          ]
+        }
+      end
+    end
+  end
+end

data/spec/spec_helpers/test_database.rb

@@ -0,0 +1,79 @@
+require 'sequel'
+require 'rspec'
+require 'spec_helpers/config_helpers'
+
+module Inscriber
+  # The TestDatabase is responsible for creating a SQLite database with tables and columns for testing.
+  # It is dumped after every example. To create a database, use the following format:
+  #
+  # Inscriber::TestDatabase.setup do
+  #   create_table :test do
+  #     primary_key :id
+  #     string :body
+  #     integer :test_app_id
+  #   end
+  # end
+  #
+  # Inscriber::TestDatabase.setup will return an instance of Inscriber::Database, which can be used for testing:
+  # database = Inscriber::TestDatabase.setup
+  # it 'should do something' do
+  #   Inscriber::Downloader.new(database).download
+  # end
+  #
+  class TestDatabase
+    class << self
+      def setup(&block)
+        self_config = new.tap do |config|
+          config.instance_eval(&block) if block
+        end
+        self_config.database
+      end
+
+      def reset
+        location = "./#{Inscriber::ConfigHelpers.config[:database_name]}"
+        File.unlink(location) if File.exists?(location)
+      end
+    end
+
+    attr_accessor :database
+
+    def initialize
+      @database ||= Inscriber::Database.new(Inscriber::ConfigHelpers.config) 
+    end
+
+    def db_connection
+      database.connection
+    end
+
+    def create_table(name, &block)
+      opts = { name: name, database: database }
+      TableCreator.new(opts).setup(&block)
+    end
+  end
+
+  class TableCreator
+    attr_accessor :name, :database
+
+    def initialize(opts)
+      @name     = opts[:name]
+      @database = opts[:database]
+    end
+
+    def setup(&block)
+      db_connection.create_table(name) { instance_eval &block }
+    end
+
+    private
+
+    def db_connection
+      database.connection
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.around(:each) do |example|
+    Inscriber::TestDatabase.reset
+    example.run
+  end
+end

data/spec/uploader_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'spec_helpers/config_helpers'
+
+describe Inscriber::Uploader do
+  let!(:database) do
+    Inscriber::TestDatabase.setup do
+      create_table :test_translations do
+        primary_key :id
+        integer :test_id
+        string :body
+        string :locale
+      end
+    end
+  end
+
+  let!(:config) do
+    {
+      "fr" => {
+        "test_translations" => [
+          {
+            "body" => "Chaîne de test",
+            "test_id" => 1
+          }
+        ]
+      }
+    }
+  end
+
+  let(:db) do
+    database.connection.from(config["fr"].keys.first)
+  end
+
+  describe '.upload' do
+    it 'should upload the data to the database' do
+      opts = { database: database, table: config["fr"].keys.first, records: config["fr"]["test_translations"], locale: "fr" }
+      Inscriber::Uploader.new(opts).upload
+      query = { 
+        :locale => config.keys.first, 
+        :body => config["fr"]["test_translations"].first["body"]
+      }
+      expect(db.where(query).all.length).to be 1
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: inscriber
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ian Florentino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A tool for downloading localized data from your database and creating
+  a locale file for translations
+email:
+- ian@pryntcases.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/inscriber.rb
+- lib/inscriber/config.rb
+- lib/inscriber/connection_string.rb
+- lib/inscriber/database.rb
+- lib/inscriber/downloader.rb
+- lib/inscriber/exporter.rb
+- lib/inscriber/inserter.rb
+- lib/inscriber/table_helper.rb
+- lib/inscriber/uploader.rb
+- lib/inscriber/version.rb
+- spec/config_spec.rb
+- spec/connection_string_spec.rb
+- spec/database_spec.rb
+- spec/downloader_spec.rb
+- spec/exporter_spec.rb
+- spec/inserter_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helpers/config_helpers.rb
+- spec/spec_helpers/test_database.rb
+- spec/uploader_spec.rb
+homepage: https://github.com/prynt/inscriber
+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.10
+signing_key: 
+specification_version: 4
+summary: A tool for downloading localized data from your database and creating a locale
+  file for translations
+test_files: []