credere 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dc97b9ba3d1567dd4b218cab8bc15c08b7795c387e0ef79c8b7fa67eddd539f
-  data.tar.gz: e3dc71788fceebfb57cbd01d2e299b01066ba7bdd11814df12676dff9bfaf00e
+  metadata.gz: df241e74cbe54c0d5579b1cd2818db405c4ec1325bc97c2aff138e10f791cd32
+  data.tar.gz: 6aba4d648903d013a981daeb4764acc7f6854eaeeba73fabd7aab13d13a579e0
 SHA512:
-  metadata.gz: c7e1b0abe0122097310728eab355d0575e7afbb82fb411ee682312d43f95253d20d551a4952be61bdfd7b3ba0b3bd77700f50dfb7443e67c0a8a531a1dd32564
-  data.tar.gz: cc9203e87cad1fb48cec91ab8ee21adbb5e2beeef5f2aa2ba02aed2f0cea36165709619b92650c62de64ba7c43c4b717541b0062934150e53b2b4d9688e32f0d
+  metadata.gz: 1bf4dae13f82850a2388dc9a84f79bc221fc94072033d4febe22d64faaac6e63e41b6406855bbdd72917fa71b5ece6daddcf7344cda5a665b04e99d3587a7243
+  data.tar.gz: 805f93e48c080a7bafeaed677758621e3f43187a3f5ff40c507e88a71dc23d8954c3b3dd351e9bb692c1ccf0e8254a3c23400c358269fb09dd7886337da7a2c9

data/README.markdown

@@ -1,6 +1,5 @@
 credere
 =================
-<!-- [![Build Status](https://travis-ci.org/legalshield/credere.svg?branch=master)](https://travis-ci.org/legalshield/credere) [![Coverage Status](https://coveralls.io/repos/github/legalshield/credere/badge.svg?branch=master)](https://coveralls.io/github/legalshield/credere?branch=master) -->
 
 The credere plugin is a Ruby on Rails Engine which provides a double entry accounting system for your application.
 
@@ -10,8 +9,6 @@ Compatibility
 * Ruby versions: MRI 2.2.2+ (should work with earlier versions if using Rails 4)
 * Rails versions: ~> 5.0, ~> 4.0
 
-For earlier versions, and upgrading, please see the section titled [Previous Versions](https://github.com/legalshield/credere#previous-versions)
-
 Installation
 ============
 
@@ -286,7 +283,7 @@ rake db:migrate
 - Add an initializer to your Rails application, i.e. `config/initializers/credere.rb`
 
 ```ruby
-credere.config do |config|
+Credere.config do |config|
   config.enable_tenancy = true
   config.tenant_class = 'Tenant'
 end
@@ -305,6 +302,29 @@ entry = Credere::Entry.new(
                   {:account => credit_account, :amount => 100.00}])
 ```
 
+If you are pre-seeding a system, or are adding Credere to a system with existing Users (or whatever you are associating your leger entries with) you may wish to consider scripting the creation of your Book of Accounts for all Users.
+
+UUID Support
+============
+
+Not every system supports basic integer IDs for primary keys. By default, Credere uses integers for primary keys, but offers the ability to use UUIDs for the primary keys through the following migration. 
+
+*NOTE: This migration will need to be run _after_ the multitenancy support migration*
+
+```sh
+bundle exec rails g credere:id_to_uuid
+```
+
+- Run the migration
+
+```sh
+rake db:migrate
+```
+
+Credere should now be set up to utilize your UUIDs.
+
+*NOTE: This should be done during initial installation only. Running this at any other time will cause a loss of data.*
+
 Reporting Views
 ===============
 
@@ -312,7 +332,7 @@ The Engine provides controllers and views for rendering basic reports, including
 
 These views and controllers are read-only for reporting purposes. It is assumed entry creation will occur within your applications code.
 
-Routing is supplied via an engine mount point. credere can be mounted on a subpath in your existing Rails 3 app by adding the following to your routes.rb:
+Routing is supplied via an engine mount point. credere can be mounted on a subpath in your existing Rails app by adding the following to your routes.rb:
 
 ```ruby
 mount Credere::Engine => "/credere", :as => "credere"
@@ -320,34 +340,12 @@ mount Credere::Engine => "/credere", :as => "credere"
 
 *NOTE: The `Credere::ApplicationController` does not currently support authentication. If you enable routing, the views will be publicly available on your mount point. Authentication can be added by overriding the controller.*
 
-<!-- *Future versions of Credere will allow for customization of authentication.* -->
-
 
 Previous Versions
 =================
 
-<!-- For the rails 3 version, you can go here:
-
-[https://github.com/legalshield/credere/tree/rails3](https://github.com/legalshield/credere/tree/rails3)
-
-For the rails 2 version, you can go here:
-
-[https://github.com/legalshield/credere/tree/rails2](https://github.com/legalshield/credere/tree/rails2)
-
-* Gems in RubyGems.org >= 0.5.0 support Rails 3
-* Gems in RubyGems.org >= 0.8.0 support Rails 4
-* Gems in RubyGems.org >= 0.9.0 support Rails ~> 4.1 -->
 * Gems in RubyGems.org >= 0.10.0 support Rails ~> 5.0
 
-<!-- Upgrading from older versions
------------------------------
-
-As credere is still in alpha, there have been some breaking changes with previous versions.
-
-If you are upgrading, please check the Wiki for guides on how to properly upgrade credere to deal with the changes:
-
-[Upgrade Notes](https://github.com/legalshield/credere/wiki/Updrade-Notes) -->
-
 Testing
 =======
 

data/app/views/layouts/credere/_navigation.html.erb

@@ -8,7 +8,7 @@
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
       </button>
-      <a class="navbar-brand" href="/">&nbsp;Plutus</a>
+      <a class="navbar-brand" href="/">&nbsp;Credere</a>
     </div>
     <div class="collapse navbar-collapse">
       <ul class="nav navbar-nav">

data/app/views/layouts/credere/application.html.erb

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Plutus</title>
+  <title>Credere</title>
   <%= stylesheet_link_tag    "credere/application", media: "all" %>
   <%= javascript_include_tag "credere/application" %>
   <%= csrf_meta_tags %>

data/lib/credere/version.rb

@@ -1,3 +1,3 @@
 module Credere
-  VERSION = "0.10.1"
+  VERSION = "0.10.2"
 end

data/lib/generators/credere/USAGE

@@ -10,13 +10,3 @@ Installation:
 
     Once generated, simply run:
         rake db:migrate
-
-Upgrade < 0.8 -> 0.9+:
-    rails g credere:upgrade_credere
-
-    This will:
-        Create a migration in the application for renaming the
-        "Transaction" table, columns and indexes to "Entry" tables.
-        
-    Once generated, simply run:
-        rake db:migrate

data/lib/generators/credere/id_to_uuid_generator.rb

@@ -0,0 +1,12 @@
+# lib/generators/credere/credere_generator.rb
+require 'rails/generators'
+require 'rails/generators/migration'
+require_relative 'base_generator'
+
+module Credere
+  class IdToUuidGenerator < BaseGenerator
+    def create_migration_file
+      migration_template 'id_to_uuid_migration.rb', 'db/migrate/id_to_uuid_credere_tables.rb'
+    end
+  end
+end

data/lib/generators/credere/templates/id_to_uuid_migration.rb

@@ -0,0 +1,101 @@
+class IdToUuidCredereTables < ActiveRecord::Migration[5.2]
+  def up
+    # Migrate all integer IDs to UUID in all Credere tables.
+    add_column :credere_accounts, :uuid, :uuid, default: -> { "uuid_generate_v4()" }, null: false
+
+    change_table :credere_accounts do |t|
+      t.remove :id
+      t.rename :uuid, :id
+    end
+
+    if column_exists? :credere_accounts, :tenant_id
+      add_column :credere_accounts, :tenant_uuid, :uuid, default: -> { "uuid_generate_v4()" }, null: false
+
+      change_table :credere_accounts do |t|
+        t.remove :tenant_id
+        t.rename :tenant_uuid, :tenant_id
+      end
+
+      add_index :credere_accounts, :tenant_id
+    end
+
+    execute "ALTER TABLE credere_accounts ADD PRIMARY KEY (id);"
+
+    add_column :credere_amounts, :uuid, :uuid, default: -> { "uuid_generate_v4()" }, null: false
+    add_column :credere_amounts, :account_uuid, :uuid, default: -> { "uuid_generate_v4()" }, null: false
+    add_column :credere_amounts, :entry_uuid, :uuid, default: -> { "uuid_generate_v4()" }, null: false
+
+    change_table :credere_amounts do |t|
+      t.remove :id
+      t.rename :uuid, :id
+      t.remove :account_id
+      t.rename :account_uuid, :account_id
+      t.remove :entry_id
+      t.rename :entry_uuid, :entry_id
+    end
+
+    add_index :credere_amounts, :account_id
+    add_index :credere_amounts, :entry_id
+
+    execute "ALTER TABLE credere_amounts ADD PRIMARY KEY (id);"
+
+    add_column :credere_entries, :uuid, :uuid, default: -> { "uuid_generate_v4()" }, null: false
+
+    change_table :credere_entries do |t|
+      t.remove :id
+      t.rename :uuid, :id
+    end
+
+    execute "ALTER TABLE credere_entries ADD PRIMARY KEY (id);"
+  end
+
+  def down
+    # Migrate all UUID IDs to integers in all Credere tables. Why would you want to?
+    add_column :credere_accounts, :temp_id, :integer, null: false
+
+    change_table :credere_accounts do |t|
+      t.remove :id
+      t.rename :temp_id, :id
+    end
+
+    if column_exists? :credere_accounts, :tenant_id
+      add_column :credere_accounts, :temp_tenant_id, :integer
+
+      change_table :credere_accounts do |t|
+        t.remove :tenant_id
+        t.rename :temp_tenant_id, :tenant_id
+      end
+
+      add_index :credere_accounts, :tenant_id
+    end
+
+    execute "ALTER TABLE credere_accounts ADD PRIMARY KEY (id);"
+
+    add_column :credere_amounts, :temp_id, :integer, null: false
+    add_column :credere_amounts, :temp_account_id, :integer, null: false
+    add_column :credere_amounts, :temp_entry_id, :integer, null: false
+
+    change_table :credere_amounts do |t|
+      t.remove :id
+      t.rename :temp_id, :id
+      t.remove :temp_account_id
+      t.rename :temp_account_uuid, :account_id
+      t.remove :temp_entry_id
+      t.rename :temp_entry_uuid, :entry_id
+    end
+
+    add_index :credere_amounts, :account_id
+    add_index :credere_amounts, :entry_id
+
+    execute "ALTER TABLE credere_amounts ADD PRIMARY KEY (id);"
+
+    add_column :credere_entries, :temp_id, :integer, null: false
+
+    change_table :credere_entries do |t|
+      t.remove :id
+      t.rename :temp_id, :id
+    end
+
+    execute "ALTER TABLE credere_entries ADD PRIMARY KEY (id);"
+  end
+end

data/lib/generators/credere/templates/tenant_migration.rb

@@ -1,6 +1,6 @@
-class TenantPlutusTables < ActiveRecord::Migration[5.2]
+class TenantCredereTables < ActiveRecord::Migration[5.2]
   def change
-    # add a tenant column to plutus accounts table.
+    # add a tenant column to credere accounts table.
     add_column :credere_accounts, :tenant_id, :integer, index: true
   end
 end

data/lib/generators/credere/templates/update_migration.rb

@@ -1,4 +1,4 @@
-class UpdatePlutusTables < ActiveRecord::Migration[5.2]
+class UpdateCredereTables < ActiveRecord::Migration[5.2]
   def change
     # we have to remove these indexes because the temporary
     # table index name is too long

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: credere
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
-- Michael Bulat, Eric Roberts
+- Eric Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,11 +52,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: The credere plugin provides a complete double entry accounting system
+description: The Credere plugin provides a complete double entry accounting system
   for use in any Ruby on Rails application. The plugin follows general Double Entry
   Bookkeeping practices. All calculations are done using BigDecimal in order to prevent
   floating point rounding errors. The plugin requires a decimal type on your database
-  as well.
+  as well. It is strongly based off of the Plutus gem.
 email: ericroberts@legalshieldcorp.com
 executables: []
 extensions: []
@@ -111,7 +111,9 @@ files:
 - lib/generators/credere/add_date_upgrade_generator.rb
 - lib/generators/credere/base_generator.rb
 - lib/generators/credere/credere_generator.rb
+- lib/generators/credere/id_to_uuid_generator.rb
 - lib/generators/credere/templates/add_date_migration.rb
+- lib/generators/credere/templates/id_to_uuid_migration.rb
 - lib/generators/credere/templates/migration.rb
 - lib/generators/credere/templates/tenant_migration.rb
 - lib/generators/credere/templates/update_migration.rb
@@ -145,7 +147,8 @@ files:
 - spec/support/amount_shared_examples.rb
 - spec/support/factory_girl_helpers.rb
 homepage: http://github.com/legalshield/credere
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []