better_record 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 714bdfe5593dca0ec99aa991dc68e1c432f2ff730ad8c78bad43d6172714b10c
-  data.tar.gz: 05523c1546ac5d85673b2f8d9473dc2371f9d6bce315d4fb6aa77832b3cdedd9
+  metadata.gz: 13ce1aa3a062c924a936fea3c3fcb1f4e10fba5e775e0af7ff0a23aad74e9cd0
+  data.tar.gz: b89dc1cbe073de860b99c0389eada900eeab147b775d4fe6887f2a1860b8f248
 SHA512:
-  metadata.gz: 0b4fc40ce72b44600fe6a8167745f1a3147080ea38afecb84fe2bb35b599dc7b6ec22ba6f0b71963a020c08805fd5697437dadcfaaa592612f1032bf3195e88d
-  data.tar.gz: 1d40b47387cae6dbf65d539ae10aea6b29074b3837fc218604c407390f348df9b4cd7b8bf82981fa8a31a5f0f4603b7c685b3574547eb1058dd39f8bc8d7166a
+  metadata.gz: 566ba8d84f32b08046359cbccac6edccc2d8e1e1a47598c94a16fbc6c9a4808bc28c56128f546d08f48fc70bd5e6148590ba41224bc7c39336e5a8cc79289dbb
+  data.tar.gz: 65f4d70fb45fd202dc99e094a1ff4609884d6fcfb3983cdbbd38e990343888ac0ac668d26390b69313499f9507203aa492c8a904421450b0620c30702c102629

data/Rakefile

@@ -1,27 +1,21 @@
+#!/usr/bin/env rake
 begin
-  require 'bundler/setup'
+ require 'bundler/setup'
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'BetterRecord'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+Bundler::GemHelper.install_tasks
 
-require 'bundler/gem_tasks'
+Dir[File.join(File.dirname(__FILE__), 'lib/tasks/**/*.rake')].each {|f| load f }
 
-require 'rake/testtask'
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
 
-task default: :test
+task default: :spec

data/app/models/better_record/table_size.rb

@@ -1,38 +1,38 @@
 module BetterRecord
   class TableSize < Base
     # == Constants ============================================================
-    LOAD_TABLE_DATA_SQL = <<-SQL
+    UPDATE_TABLE_SIZES_SQL = <<-SQL
       BEGIN WORK;
-      LOCK #{BetterRecord.db_audit_schema}.table_sizes;
-      TRUNCATE #{BetterRecord.db_audit_schema}.table_sizes;
-      INSERT INTO #{BetterRecord.db_audit_schema}.table_sizes
-      (
-        SELECT
-          *,
-          pg_size_pretty(total_bytes) AS total,
-          pg_size_pretty(idx_bytes) AS idx,
-          pg_size_pretty(toast_bytes) AS toast,
-          pg_size_pretty(tbl_bytes) AS tbl
-        FROM (
+        LOCK TABLE #{BetterRecord.db_audit_schema}.table_sizes;
+        TRUNCATE TABLE #{BetterRecord.db_audit_schema}.table_sizes;
+        INSERT INTO #{BetterRecord.db_audit_schema}.table_sizes (
           SELECT
             *,
-            total_bytes - idx_bytes - COALESCE(toast_bytes,0) AS tbl_bytes
+            pg_size_pretty(total_bytes) AS total,
+            pg_size_pretty(idx_bytes) AS idx,
+            pg_size_pretty(toast_bytes) AS toast,
+            pg_size_pretty(tbl_bytes) AS tbl
           FROM (
-            SELECT c.oid,nspname AS schema, relname AS name
-            , c.reltuples AS apx_row_count
-            , pg_total_relation_size(c.oid) AS total_bytes
-            , pg_indexes_size(c.oid) AS idx_bytes
-            , pg_total_relation_size(reltoastrelid) AS toast_bytes
-            FROM pg_class c
-            LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
-            WHERE relkind = 'r'
-          ) tmp_table_sizes
-        ) tmp_table_sizes
-      );
+            SELECT
+              *,
+              total_bytes - idx_bytes - COALESCE(toast_bytes,0) AS tbl_bytes
+            FROM (
+              SELECT c.oid,nspname AS schema, relname AS name
+              , c.reltuples AS row_estimate
+              , pg_total_relation_size(c.oid) AS total_bytes
+              , pg_indexes_size(c.oid) AS idx_bytes
+              , pg_total_relation_size(reltoastrelid) AS toast_bytes
+              FROM pg_class c
+              LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
+              WHERE relkind = 'r'
+            ) table_sizes
+          ) table_sizes
+        );
       COMMIT WORK;
     SQL
 
     # == Attributes ===========================================================
+    cattr_accessor :last_updated
     self.primary_key = :oid
     self.table_name = "#{BetterRecord.db_audit_schema}.table_sizes"
 
@@ -52,12 +52,14 @@ module BetterRecord
       super *args
     end
 
-    def self.reload_data
-      connection.execute LOAD_TABLE_DATA_SQL
+    def self.all
+      reload_data if last_updated.blank? || (super.first.last_updated > 1.hour.ago)
+      super
     end
 
-    def self.tmp_table_exists?
-      connection.query_values("SELECT temp_table_exists('tmp_table_sizes')").first
+    def self.reload_data
+      @@last_updated ||= Time.now
+      connection.execute UPDATE_TABLE_SIZES_SQL
     end
 
     # def self.default_print

data/config/initializers/core_ext/date.rb

@@ -0,0 +1,9 @@
+class Date
+  def month_name
+    Date::MONTHNAMES[month]
+  end
+
+  def self.today
+    current
+  end
+end

data/config/initializers/dkim.rb

@@ -0,0 +1,7 @@
+if defined?(Dkim) && ENV['DKIM_PATH'] && File.exists?(ENV['DKIM_PATH'])
+  Dkim::domain      = ENV.fetch('DKIM_DOMAIN') { BetterRecord.app_domain_name }
+  Dkim::selector    = `hostname`.strip.to_sym
+  Dkim::private_key = File.read(ENV['DKIM_PATH'])
+  # This will sign all ActionMailer deliveries
+  ActionMailer::Base.register_interceptor(Dkim::Interceptor)
+end

data/config/initializers/redis_store.rb

@@ -0,0 +1,24 @@
+if defined?(Redis) && defined?(Redis::Namespace)
+
+  begin
+    tmp_rds = Redis::Namespace.new("#{Rails.application.class.parent_name}::active_page", redis: Redis.new(url: ENV.fetch('REDIS_URL') { 'redis://localhost:6379/1' }))
+
+    tmp_rds.get('test')
+  rescue
+    if (!Rails.env.production? && !Boolean.parse(ENV.fetch('FORCE_REDIS') { false })) || Boolean.parse(ENV.fetch('ALLOW_FAKE_REDIS') { false })
+      require BetterRecord::Engine.root.join('lib', 'better_record', 'fake_redis')
+      puts "WARNING!!! Redis Server not found"
+      tmp_rds = BetterRecord::FakeRedis.new
+    else
+      raise
+    end
+  end
+
+  Rails.application.class.parent.const_set('REDIS', tmp_rds)
+
+  module Rails
+    def self.redis
+      Rails.application.class.parent.const_get('REDIS')
+    end
+  end
+end

data/lib/better_record.rb

@@ -6,17 +6,19 @@ module BetterRecord
                   :db_audit_schema,
                   :has_audits_by_default,
                   :audit_relation_name,
-                  :layout_template
+                  :layout_template,
+                  :app_domain_name
   end
-  self.default_polymorphic_method = :polymorphic_name
-  self.db_audit_schema = ENV.fetch('DB_AUDIT_SCHEMA') { 'auditing' }
+  self.default_polymorphic_method = (ENV.fetch('BR_DEFAULT_POLYMORPHIC_METHOD') { :polymorphic_name }).to_sym
+  self.db_audit_schema = ENV.fetch('BR_DB_AUDIT_SCHEMA') { 'auditing' }
   self.has_audits_by_default = ActiveRecord::Type::Boolean.new.cast(ENV.fetch('BR_ADD_HAS_MANY') { false })
   self.audit_relation_name = (ENV.fetch('BR_AUDIT_RELATION_NAME') { 'audits' }).to_sym
   self.layout_template = (ENV.fetch('BR_LAYOUT_TEMPLATE') { 'better_record/layout' }).to_s
+  self.app_domain_name = (ENV.fetch('APP_DOMAIN_NAME') { 'non_existant_domain.com' }).to_s
 end
 
 Dir.glob("#{File.expand_path(__dir__)}/better_record/*").each do |d|
-  require d
+  require d unless (d =~ /fake/)
 end
 
 ActiveSupport.on_load(:active_record) do

data/lib/better_record/engine.rb

@@ -1,5 +1,12 @@
 module BetterRecord
   class Engine < ::Rails::Engine
     isolate_namespace BetterRecord
+    config.generators do |g|
+      g.templates.unshift File::expand_path("../templates", File.dirname(__FILE__))
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_bot, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
   end
 end

data/lib/better_record/fake_redis.rb

@@ -0,0 +1,94 @@
+module BetterRecord
+  class FakeRedis
+    def data
+      @data ||= {}
+    end
+
+    def incr(key)
+      data[key] ||= 0
+      data[key] += 1
+    end
+
+    def decr(key)
+      data[key] ||= 0
+      data[key] -= 1
+    end
+
+    def set(key, val)
+      data[key] = val
+    end
+
+    def get(key)
+      data[key].dup
+    end
+
+    def lpush(key, val)
+      require_array
+      data[key].unshift val
+      data[key].size
+    end
+
+    def lrem(key, count, val)
+      require_array
+      start_idx = 0
+      arr = data[key]
+      removed = 0
+
+      if count == 0
+        removed = (arr.select {|v| v != val}).size
+        arr.select! {|v| v != val}
+      else
+        arr.reverse! if count < 0
+
+        count.abs.times do
+          removed += 1 unless arr.delete_at(arr.index(val) || arr.size).nil?
+        end
+
+        arr.reverse! if count < 0
+      end
+
+      data[key] = arr
+      removed
+    end
+
+    def lrange(key, start_idx, end_idx = -1)
+      data[key][start_idx..end_idx] || []
+    end
+
+    def rpush(key, val)
+      require_array
+      data[key] << val
+      data[key].size
+    end
+
+    def rpushx(key, val)
+      return 0 unless data[key]
+      rpush key, val
+    end
+
+    def rpop(key)
+      require_array
+      data[key].pop
+    end
+
+    def rpoplpush(one, two)
+      val = rpop(one)
+      lpush two, val
+      val
+    end
+
+    def method_missing
+      return nil
+    end
+
+    private
+      def require_array(key)
+        data[key] ||= []
+        raise_wrong_type unless data[key].is_a?(Array)
+      end
+
+      def raise_wrong_type
+        raise CommandError.new("WRONGTYPE Operation against a key holding the wrong kind of value")
+      end
+  end
+end

data/lib/better_record/version.rb

@@ -1,3 +1,3 @@
 module BetterRecord
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/tasks/spec/attributes.rake

@@ -3,7 +3,13 @@ namespace :spec do
   task attributes: :environment do |t, args|
     raise 'No Model Given' unless ARGV[1].present?
     model_name = ARGV[1]
-    file_path = Rails.root.join('spec', 'models', "#{model_name.underscore}_spec.rb")
+    root_path = ''
+    if model_name =~ /better\_?record/i
+      root_path = BetterRecord::Engine.root
+    else
+      root_path = Rails.root
+    end
+    file_path = root_path.join('spec', 'models', "#{model_name.underscore}_spec.rb")
     if File.exists?(file_path)
       file = File.read(file_path)
 

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link better_record_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.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, vendor/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/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < BetterRecord::Base
+  self.abstract_class = true
+end