bulb 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 984ba929900ecc1d616b8f807f1fdd9f6500f4cb8e62ab22523d936ccb57fd00
-  data.tar.gz: ea4d21695522c109fb53b767d993e481b9b679c162c4ce2e3fcdfbdc26cca4d7
+  metadata.gz: 4d8fbeacdbc0bd0d8bdb90769e4bb4e25e3a9327847f5b690605a72ad7c29d29
+  data.tar.gz: 5f3cc7e8cd6778b4afbee05e73de2371929b3fac18b82263c10e643927d36124
 SHA512:
-  metadata.gz: 5b9621fb449e3985fb2ff2bbc110bfae13480ade7c744531a5417eac13b9714547326d35c696b87b487fe1fd1341a2af118a55e289a87db0b37fcd159608c7a9
-  data.tar.gz: ee4d4b2f85f9a6ea2b9245ee6589c431920de6941a7aada5f279cad71e81d0d9f54b27fa8ddb1f822ccce165128eb7a5f12031764f4adddf846fcf70003e0587
+  metadata.gz: f9c474bbb7aabc5cf420731d94ce969ac2327f3b3e6bf37f9b8a3ac1edd1214747d34aaba27319a8460c1dc8cf1b0fac46eac1446955e838ec52ef43e6771b42
+  data.tar.gz: d1e1ccedb16cfbbe54ae1ef1253feba5d77d9fef8c1bb2bcd36b191915e6c419d6f543890a3a515c864483f7fffbea9177e5c8232d999e347eff48a24d87217c

data/README.md

@@ -24,8 +24,15 @@ $ bundle
 
 ## Usage
 
-Once installed, you can mount the engine to whichever path you
-like:
+Once installed, you need to generate the needed migrations to
+create the tables and migrate your database:
+
+```bash
+$ rake bulb:install:migrations
+$ rake db:migrate
+```
+
+Then, you can mount the engine to whichever path you like:
 
 ```ruby
 mount Bulb::Engine => "/git"
@@ -34,6 +41,18 @@ mount Bulb::Engine => "/git"
 Then your repositories will be available through `/git/:group-slug/:slug`
 like `/git/sites/personal`.
 
+To configure where your repositories are stored and who own them, you can
+open your `config/application.rb` or any environment-specific file and add
+the following:
+
+```ruby
+config.bulb.repositories_path = '/srv/git/'
+config.bulb.repositories_owner = 'git'
+```
+
+Where `git` is a Unix user on your system that must be the owner of the
+repository folders.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/bulb/blob_controller.rb

@@ -5,8 +5,10 @@ module Bulb
 
     def show
       @git_repository = @repository.git_repository
-
       @blob_hash = @git_repository.head.target.tree.path(params[:path])
+
+      redirect_to repository_tree_path if @blob_hash[:type] == :tree
+
       @blob = @git_repository.lookup(@blob_hash[:oid])
     end
   end

data/app/controllers/bulb/tree_controller.rb

@@ -5,8 +5,10 @@ module Bulb
 
     def show
       @git_repository = @repository.git_repository
-
       tree_hash = @git_repository.head.target.tree.path(params[:path])
+
+      redirect_to repository_blob_path if tree_hash[:type] == :blob
+
       @tree = @git_repository.lookup(tree_hash[:oid])
     end
   end

data/app/helpers/bulb/application_helper.rb

@@ -9,5 +9,32 @@ module Bulb
       root = root ? (root + "/") : ""
       bulb.repository_blob_path(reference: 'master', path: root + name)
     end
+
+    def breadcrumb
+      parts = params[:path].split("/")
+      last  = parts.pop
+
+      reference  = params[:reference]
+      group_slug = params[:group_slug]
+      slug       = params[:slug]
+
+      elements = []
+
+      elements << content_tag(:li) do
+        link_to @repository.slug, bulb.repository_path(group_slug, slug)
+      end
+
+      parts.each_with_index do |part, index|
+        path = parts[0..index].join("/")
+
+        elements << content_tag(:li) do
+          link_to part, bulb.repository_tree_path(reference: reference, path: path)
+        end
+      end
+
+      elements << content_tag(:li, last)
+
+      content_tag(:ul, elements.join.html_safe, class: 'breadcrumb')
+    end
   end
 end

data/app/models/bulb/group.rb

@@ -1,5 +1,7 @@
 module Bulb
   class Group < ApplicationRecord
     has_many :repositories
+
+    validates_uniqueness_of :slug, case_sensitive: false
   end
 end

data/app/models/bulb/repository.rb

@@ -6,6 +6,9 @@ module Bulb
 
     before_create :create_git_repository
 
+    validates_uniqueness_of :slug, scope: :bulb_group_id
+    validates :fs_repository_path, 'bulb/unexisting': true, on: :create
+
     def git_repository
       @git_repository ||= Rugged::Repository.new(fs_repository_path)
     end
@@ -14,17 +17,19 @@ module Bulb
       def create_git_repository
         full_path = fs_repository_path
 
-        raise RuntimeError.new if File.exist?(full_path)
-
         FileUtils.mkdir_p(full_path)
         Rugged::Repository.init_at(full_path, :bare)
+
+        if (owner = Bulb.repositories_owner).present?
+          FileUtils.chown_R(owner, owner, full_path)
+        end
       end
 
       def fs_repository_path
         if group.nil?
-          File.join(Bulb.repositories_path, slug)
+          File.join(Bulb.repositories_path, "#{slug}.git")
         else
-          File.join(Bulb.repositories_path, group.slug, slug)
+          File.join(Bulb.repositories_path, group.slug, "#{slug}.git")
         end
       end
   end

data/app/validators/bulb/unexisting_validator.rb

@@ -0,0 +1,9 @@
+module Bulb
+  class UnexistingValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      if File.exist?(value)
+        record.errors.add attribute, 'must not exist'
+      end
+    end
+  end
+end

data/app/views/bulb/blob/show.html.erb

@@ -1,3 +1,16 @@
-<div class="blob highlight">
-  <%= raw highlight_blob @blob_hash[:name], @blob.content %>
-</div>
+<%= breadcrumb %>
+
+<% unless @blob.binary? %>
+  <div class="blob highlight">
+    <%= raw highlight_blob @blob_hash[:name], @blob.content.force_encoding(Encoding::UTF_8) %>
+  </div>
+<% else %>
+  <div class="blob">
+    <% match = @blob_hash[:name].match(/\.(jpg|jpeg|png|gif)$/) %>
+    <% if match %>
+      <img src="data:image/<%= match[1] %>;base64,<%= Base64.strict_encode64(@blob.content) %>">
+    <% else %>
+      Nothing to display.
+    <% end %>
+  </div>
+<% end %>

data/app/views/bulb/tree/show.html.erb

@@ -1 +1,3 @@
+<%= breadcrumb %>
+
 <%= render partial: 'tree', locals: { tree: @tree } %>

data/db/migrate/20220116171708_add_unique_index_on_slugs.rb

@@ -0,0 +1,6 @@
+class AddUniqueIndexOnSlugs < ActiveRecord::Migration[6.1]
+  def change
+    add_index :bulb_groups, :slug, unique: true
+    add_index :bulb_repositories, [:bulb_group_id, :slug], unique: true
+  end
+end

data/lib/bulb/engine.rb

@@ -1,5 +1,7 @@
 module Bulb
   class Engine < ::Rails::Engine
     isolate_namespace Bulb
+
+    config.bulb = Bulb
   end
 end

data/lib/bulb/version.rb

@@ -1,3 +1,3 @@
 module Bulb
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/bulb.rb

@@ -2,4 +2,5 @@ require "bulb/engine"
 
 module Bulb
   mattr_accessor :repositories_path
+  mattr_accessor :repositories_owner
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Robin Dupret
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-16 00:00:00.000000000 Z
+date: 2022-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -86,10 +86,10 @@ files:
 - app/helpers/bulb/application_helper.rb
 - app/helpers/bulb/text_helper.rb
 - app/jobs/bulb/application_job.rb
-- app/mailers/bulb/application_mailer.rb
 - app/models/bulb/application_record.rb
 - app/models/bulb/group.rb
 - app/models/bulb/repository.rb
+- app/validators/bulb/unexisting_validator.rb
 - app/views/bulb/blob/show.html.erb
 - app/views/bulb/repositories/show.html.erb
 - app/views/bulb/tree/_blob.html.erb
@@ -99,6 +99,7 @@ files:
 - config/routes.rb
 - db/migrate/20210809182658_create_bulb_groups.rb
 - db/migrate/20210809182912_create_bulb_repositories.rb
+- db/migrate/20220116171708_add_unique_index_on_slugs.rb
 - lib/bulb.rb
 - lib/bulb/engine.rb
 - lib/bulb/version.rb

data/app/mailers/bulb/application_mailer.rb

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