source_browser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc01ebe8cf52d45b5288d2884f8da766e489036b1c05d7024692bb2f6620dd64
+  data.tar.gz: f93945cdd7f4d22e613cd687bbc7244b32a8963a579a5e0df7eddef735344e3b
+SHA512:
+  metadata.gz: 6af6190eb5be7c8ca3dab742380b9a1162b117014147c472afdb6c5cfb67ea93ecab6a6b47d25fd65a4c98d650aaf6ab0fbc7be645582d9fbb935ea32c510426
+  data.tar.gz: 0ab968a2e340c3de5002cc95a731f0c5bf91a75391c303ff162b21188f5144a1215961b05304586c1d67475c022b7a4cc2a9e66a50dffa3099cd519257866e7b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Jeff Peterson
+
+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,28 @@
+# SourceBrowser
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "source_browser"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install source_browser
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

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

@@ -0,0 +1,6 @@
+module SourceBrowser
+  class ApplicationController < ActionController::Base
+    delegate :git, to: SourceBrowser
+    helper_method :git
+  end
+end

data/app/controllers/source_browser/objects_controller.rb

@@ -0,0 +1,9 @@
+module SourceBrowser
+  class ObjectsController < ApplicationController
+    def show
+      @path = params[:id]
+      @object = git.object(@path)
+      render body: @object.contents
+    end
+  end
+end

data/app/controllers/source_browser/source_controller.rb

@@ -0,0 +1,20 @@
+require "rouge"
+
+module SourceBrowser
+  class SourceController < ApplicationController
+    def index
+      @files = git.ls_files
+    end
+
+    def show
+      @path = params[:id]
+      @object = git.object(@path)
+      @files = git.ls_files
+
+      @formatter = Rouge::Formatters::HTML.new
+      @formatter = Rouge::Formatters::HTMLLineTable.new(@formatter, line_id: "L%i", line_format: "<a href='?line=%i'>%i</a>")
+      @lexer = Rouge::Lexer.guess(filename: @path, source: @object.contents)
+      @source = @formatter.format(@lexer.lex(@object.contents))
+    end
+  end
+end

data/app/helpers/source_browser/application_helper.rb

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

data/app/jobs/source_browser/application_job.rb

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

data/app/mailers/source_browser/application_mailer.rb

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

data/app/models/source_browser/application_record.rb

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

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

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Source browser</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "source_browser/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/layouts/source_browser/source.html.erb

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= @path %></title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "source_browser/application", media: "all" %>
+  <style>
+    .rouge-line-table {
+      border-collapse: collapse;
+    }
+    .code { flex-grow: 1;}
+    <%= Rouge::Themes::Molokai.render(scope: '.code')%>
+  </style>
+</head>
+<body>
+  <main style="display: flex; gap: 1rem">
+    <nav style="max-width: 500px; flex-shrink: 0; overflow: auto;">
+      <ul>
+        <% @files.each do |path, _| %>
+          <li>
+            <%= link_to_unless_current path, browse_path(":" + path) %>
+          </li>
+        <% end %>
+      </ul>
+    </nav>
+    <div class="code"><%= yield %></div>
+  </main>
+</body>
+</html>

data/app/views/source_browser/source/show.html.erb

@@ -0,0 +1 @@
+<%= raw @source %>

data/config/routes.rb

@@ -0,0 +1,5 @@
+SourceBrowser::Engine.routes.draw do
+  root "source#index"
+  get "*id" => "source#show", as: :browse, format: false, defaults: {format: 'html'}
+  get "objects/*id" => "objects#show", as: :object, format: false, defaults: {format: 'html'}
+end

data/lib/source_browser/engine.rb

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

data/lib/source_browser/version.rb

@@ -0,0 +1,3 @@
+module SourceBrowser
+  VERSION = "0.1.0"
+end

data/lib/source_browser.rb

@@ -0,0 +1,10 @@
+require "source_browser/version"
+require "source_browser/engine"
+require "git"
+
+module SourceBrowser
+  # Your code goes here...
+  def self.git
+    @git ||= Git.open(Rails.root)
+  end
+end

data/lib/tasks/source_browser_tasks.rake

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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: source_browser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Peterson
+- Matt Tognetti
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+description: SourceBrowser is a Rails engine for browsing source code. It is designed
+  to be used in a Rails application that is serving web pages to users.
+email:
+- jeff@concept.love
+- matt@concept.love
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/source_browser/application.css
+- app/controllers/source_browser/application_controller.rb
+- app/controllers/source_browser/objects_controller.rb
+- app/controllers/source_browser/source_controller.rb
+- app/helpers/source_browser/application_helper.rb
+- app/jobs/source_browser/application_job.rb
+- app/mailers/source_browser/application_mailer.rb
+- app/models/source_browser/application_record.rb
+- app/views/layouts/source_browser/application.html.erb
+- app/views/layouts/source_browser/source.html.erb
+- app/views/source_browser/source/index.html.erb
+- app/views/source_browser/source/show.html.erb
+- config/routes.rb
+- lib/source_browser.rb
+- lib/source_browser/engine.rb
+- lib/source_browser/version.rb
+- lib/tasks/source_browser_tasks.rake
+homepage: https://github.com/craft-concept/source_browser
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/craft-concept/source_browser
+  changelog_uri: https://github.com/craft-concept/source_browser/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.21
+signing_key:
+specification_version: 4
+summary: Rails plugin for browsing source code
+test_files: []