lazer-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f69c53ae02e5623308b813b654431f012f4d582ab0d1cd4cbf9b3a4e42c910db
+  data.tar.gz: e43efbf348011c43c5ca09c9e7555a857c9f20254cff387bd073462ecc83b93c
+SHA512:
+  metadata.gz: 949104826f2f04efda3ba465166fb430fb83e19136b9da7f882f5bedd4ef436772963940c5bfb3e2a0631baaa4eb8d0d06166cba26f9eacd97e328af7d36196a
+  data.tar.gz: 77e48ac6798734dd7b094a6b796a8be1658849664cf8d0a5600710fd68e205130b1191e3b76ef547470ec9c64e0eea766a3c4dbdeb4d4c3889954f6c7444dc71

data/README.md

@@ -0,0 +1,35 @@
+# Lazer Ruby Gem
+
+This gem provides a Rails engine that allows Lazer to import your apps scopes and Active Record relationships.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lazer-rails'
+```
+
+Bundle, and restart your server.
+
+```bash
+bundle
+```
+
+Mount the engine:
+
+```
+# config/routes.rb
+mount Lazer::Engine => "/lazer-gem-api"
+```
+
+Add a new codebase in Lazer to get an API key, then set it as an environment variable:
+
+```
+LAZER_KEY=YOUR_API_KEY
+```
+
+## How it works
+
+This gem adds two endpoints to your app, one for scopes and one for relationships. It uses the API key for authentication.
+
+The Lazer app will hit these endpoints periodically so that your Lazer instance stays up to date.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Lazer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/lazer_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/lazer .css

data/app/assets/stylesheets/lazer/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/app/controllers/lazer/application_controller.rb

@@ -0,0 +1,22 @@
+module Lazer
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    before_action :authenticate!
+
+    def authenticate!
+      if params[:api_key].blank?
+        render json: "Missing api_key param", status: 401
+        return
+      end
+      if ENV["LAZER_KEY"].blank?
+        render json: "You need to set your LAZER_KEY env variable", status: 401
+        return
+      end
+      if params[:api_key] != ENV["LAZER_KEY"]
+        render json: "api_key param doesn't match LAZER_KEY env variable", status: 401
+        return
+      end
+    end
+  end
+end

data/app/controllers/lazer/schema_controller.rb

@@ -0,0 +1,87 @@
+require_dependency "lazer/application_controller"
+
+module Lazer
+  class SchemaController < ApplicationController
+
+    def show
+      require_page!; return if performed?
+
+      Rails.application.eager_load!
+      models = ActiveRecord::Base.descendants
+
+      result = {}
+
+      page = params[:page].to_i
+      models_per_page = 30
+      offset = (page - 1) * models_per_page
+
+      models = models[offset, models_per_page] || []
+      result[:models] = models.map do |model|
+        parse_model(model)
+      end
+
+      # not necessarily needed, can get tables directly from the db
+      # result[:raw_tables] = gather_tables
+
+      result[:count] = models.length
+      result[:page] = page
+      result[:offset] = offset
+
+      render json: result.to_json
+    end
+
+    private
+
+    def connection
+      ActiveRecord::Base.connection
+    end
+
+    def gather_tables
+      connection.tables.map do |table_name|
+        { table_name =>
+          connection.columns(table_name).map do |column|
+            {
+              name: column.name,
+              type: column.type,
+            }
+          end
+        }
+      end
+    end
+
+    def parse_model(model)
+      logger.debug "Parsing: #{model.name}"
+      # return {} if model.name == "ActiveRecord::SchemaMigration"
+      model_data = {
+        name: model.name,
+        table: model.table_name,
+      }
+      associations = []
+      model.reflect_on_all_associations.each do |association|
+        associations << {
+          macro: association.macro,
+          name: association.name,
+          options: association.options,
+          table: association.table_name,
+          foreign_key: association.foreign_key,
+          # to_table: association.class_name.constantize.table_name,
+        }
+      end
+      # model_data[:columns] = model.column_names
+      # model_data[:scopes] = model.instance_variable_get(:@__scopes__)
+      model_data[:associations] = associations
+      return model_data
+    rescue => e
+      logger.debug "error parsing model #{model.name}: #{e.message}"
+      return {}
+    end
+
+    def require_page!
+      if params[:page].blank?
+        render json: "You must specify a page param", status: 422
+        return
+      end
+    end
+
+  end
+end

data/app/controllers/lazer/scopes_controller.rb

@@ -0,0 +1,71 @@
+require_dependency "lazer/application_controller"
+
+module Lazer
+  class ScopesController < ApplicationController
+
+    def show
+      render json: try_all_models.to_json
+    end
+
+    def try_all_models
+      Rails.application.eager_load!
+      models = ActiveRecord::Base.descendants
+      worked = []
+      failed = []
+      data = {}
+
+      models.each do |model|
+        begin
+          scopes = get_scopes_for_model(model)
+          if scopes.present?
+            data[model.name] = {
+              scopes: scopes,
+              table_name: model.table_name
+            }
+          end
+          worked << (model.respond_to?(:class_name) ? model.class_name : model.name)
+        rescue => e
+          failed << {
+            model: (model.respond_to?(:class_name) ? model.class_name : model.name),
+            error: e.message
+          }
+        end
+      end
+
+      { success: worked, failure: failed, data: data }
+    end
+
+    def get_scopes_for_model(model)
+      return nil unless model.respond_to?(:defined_scopes)
+
+      result = {}
+      all_sql = model.all.to_sql
+      model.defined_scopes.each do |name, block|
+        begin
+
+          # for each scope, check the arity. don't handle params for now
+          if block.respond_to?(:arity) && block.arity != 0
+            puts "skipped #{name} because arity was #{block.arity}"
+            next
+          end
+
+          scope_sql = model.send(name).to_sql
+
+          # return scopes that have a where or order only... skip joins for now
+          if !scope_sql.include?(all_sql)
+            puts "skipped #{name} because sql wasn't included"
+            next
+          end
+
+          new_sql = scope_sql.gsub(all_sql, "")&.strip
+          result[name] = new_sql
+        rescue => e
+          Rails.logger.warn "Failed processing scope #{name} on #{model.name}: #{e.message}"
+        end
+      end
+
+      result
+    end
+
+  end
+end

data/app/helpers/lazer/application_helper.rb

@@ -0,0 +1,4 @@
+module Lazer
+  module ApplicationHelper
+  end
+end

data/app/jobs/lazer/application_job.rb

@@ -0,0 +1,4 @@
+module Lazer
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/lazer/application_mailer.rb

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

data/app/models/lazer/application_record.rb

@@ -0,0 +1,5 @@
+module Lazer
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Lazer</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "lazer/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Lazer::Engine.routes.draw do
+  resource :schema, controller: :schema
+  resource :scopes, controller: :scopes
+end

data/lib/lazer/engine.rb

@@ -0,0 +1,5 @@
+module Lazer
+  class Engine < ::Rails::Engine
+    isolate_namespace Lazer
+  end
+end

data/lib/lazer/railtie.rb

@@ -0,0 +1,11 @@
+require "rails/railtie"
+
+module Lazer
+  class Railtie < ::Rails::Railtie
+    initializer "lazer.track_scopes" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.include(Lazer::TrackScopes)
+      end
+    end
+  end
+end

data/lib/lazer/track_scopes.rb

@@ -0,0 +1,18 @@
+module Lazer
+  module TrackScopes
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        def scope(name, options = nil, &block)
+          defined_scopes[name] ||= options || block
+          super
+        end
+
+        def defined_scopes
+          @defined_scopes ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/lazer/version.rb

@@ -0,0 +1,3 @@
+module Lazer
+  VERSION = '0.1.0'
+end

data/lib/lazer.rb

@@ -0,0 +1,5 @@
+require "lazer/engine"
+require "active_support"
+
+require "lazer/track_scopes"
+require "lazer/railtie" if defined?(Rails)

data/lib/tasks/lazer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :lazer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: lazer-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vic Ramon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: Provides secure endpoints to export info for Lazer Pro
+email:
+- v@vicramon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/lazer_manifest.js
+- app/assets/stylesheets/lazer/application.css
+- app/controllers/lazer/application_controller.rb
+- app/controllers/lazer/schema_controller.rb
+- app/controllers/lazer/scopes_controller.rb
+- app/helpers/lazer/application_helper.rb
+- app/jobs/lazer/application_job.rb
+- app/mailers/lazer/application_mailer.rb
+- app/models/lazer/application_record.rb
+- app/views/layouts/lazer/application.html.erb
+- config/routes.rb
+- lib/lazer.rb
+- lib/lazer/engine.rb
+- lib/lazer/railtie.rb
+- lib/lazer/track_scopes.rb
+- lib/lazer/version.rb
+- lib/tasks/lazer_tasks.rake
+homepage: https://www.github.com/vicramon/lazer-engine
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Provides secure endpoints to export info for Lazer Pro
+test_files: []