filesystem-explorer 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Pedro Rodrigues
+
+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.rdoc

@@ -0,0 +1,3 @@
+= FilesystemExplorer
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FilesystemExplorer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/filesystem_explorer/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 vendor/assets/javascripts of plugins, if any, 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/filesystem_explorer/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/filesystem_explorer/application_controller.rb

@@ -0,0 +1,53 @@
+module FilesystemExplorer
+  class ApplicationController < ::ApplicationController
+    ActionController::Streaming::X_SENDFILE_HEADER = 'X-Accel-Redirect'
+
+    attr_reader :route
+
+    helper_method :current_filesystem_explorer_path, :filesystem_explorer_root_path, :filesystem_explorer_root_name
+
+    before_filter :get_engine_configuration_options
+
+    def index
+      @path = FilesystemExplorer::FilesystemItem.new(route.path, %Q[#{params[:path]}#{".#{params[:format]}" if params[:format]}])
+      @path.parent.instance_exec { @is_parent = true } if @path.parent
+
+      render @path.exists? ? :index : :not_found
+    end
+
+    def download
+      @path = FilesystemExplorer::FilesystemItem.new(File.join('/', %Q[#{params[:path]}#{".#{params[:format]}" if params[:format]}]), root: route.path)
+      send_file @path.full_path, disposition: :attachment, x_sendfile: true
+    end
+
+    def current_filesystem_explorer_path ; return @path ; end
+
+    def filesystem_explorer_root_path(as = nil)
+      options = as.nil? ? route : get_engine_configuration_options_by_as(as)
+
+      return @filesystem_explorer_root_path ||= Rails.application.routes.url_helpers.send("#{options.as}_path")
+    end
+
+    def filesystem_explorer_root_name(as = nil)
+      options = as.nil? ? route : get_engine_configuration_options_by_as(as)
+
+      return @filesystem_explorer_root_name ||= options.as.to_s.humanize
+    end
+
+    private
+
+      def get_engine_configuration_options
+        $filesystem_explorer_route_options.each do |path, options|
+          @route = options and break if request.path =~ %r(^#{path})
+        end
+      end
+
+      def get_engine_configuration_options_by_as(as)
+        $filesystem_explorer_route_options.each do |path, options|
+          return options if options.as.to_sym == as.to_sym
+        end
+
+        return nil
+      end
+  end
+end

data/app/helpers/filesystem_explorer/application_helper.rb

@@ -0,0 +1,21 @@
+module FilesystemExplorer
+  module ApplicationHelper
+    def breakdown_path(path)
+      paths = [path]
+
+      while path = path.parent
+        paths.unshift path
+      end
+
+      paths
+    end
+
+    def method_missing(method, *args, &block)
+      if (method.to_s.end_with?('_path') || method.to_s.end_with?('_url')) && main_app.respond_to?(method)
+        main_app.send(method, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/app/views/filesystem_explorer/application/_directory.html.erb

@@ -0,0 +1,6 @@
+<tr>
+  <td><i class="fa fa-folder"></i> <%= link_to directory.is_parent? ? '..' : directory.name, File.join(filesystem_explorer_root_path, u(directory.path)) %></td>
+  <td><%= directory.modified_at.strftime('%F %T') %></td>
+  <td></td>
+  <td></td>
+</tr>

data/app/views/filesystem_explorer/application/_file.html.erb

@@ -0,0 +1,6 @@
+<tr>
+  <td><i class="fa fa-file-o"></i> <%= file.name %></td>
+  <td><%= file.modified_at.strftime('%F %T') %></td>
+  <td class="right"><%= number_to_human_size(file.size) %></td>
+  <td class="right"><%= link_to 'D', File.join(filesystem_explorer_root_path, file.path, 'download') %></td>
+</tr>

data/app/views/filesystem_explorer/application/index.html.erb

@@ -0,0 +1,28 @@
+<%
+ paths = breakdown_path(@path)
+ current = paths.pop
+%>
+<div class="row">
+  <div class="col-md-12">
+    <ol class="breadcrumb">
+      <%paths.each do |directory, index| %>
+        <li><%= link_to(directory.is_root? ? filesystem_explorer_root_name : directory.name, File.join(filesystem_explorer_root_path, directory.path)) %></li>
+      <% end %>
+      <li class="active"><%= current.is_root? ? filesystem_explorer_root_name : current.name %></li>
+    </ol>
+  </div>
+</div>
+<table class="table">
+<thead>
+  <tr>
+    <th class="col-md-8">Name</th>
+    <th class="col-md-2">Modification date</th>
+    <th class="col-md-1">Size</th>
+    <th class="col-md-1"></th>
+  </tr>
+  </thead>
+  <tbody>
+    <%= render @path.parent if @path.parent %>
+    <%= render @path.children %>
+  </tbody>
+</table>

data/app/views/filesystem_explorer/application/not_found.html.erb

@@ -0,0 +1,15 @@
+<%
+ paths = breakdown_path(@path)
+ current = paths.pop
+%>
+<div class="row">
+  <div class="col-md-12">
+    <ol class="breadcrumb">
+      <% paths.each do |directory, index| %>
+        <li><%= link_to(directory.is_root? ? filesystem_explorer_root_name : directory.name, File.join(filesystem_explorer_root_path, directory.path)) %></li>
+      <% end %>
+      <li class="active"><%= current.is_root? ? filesystem_explorer_root_name : current.name %></li>
+    </ol>
+  </div>
+</div>
+<%= current.path %> not found!

data/config/routes.rb

@@ -0,0 +1,5 @@
+FilesystemExplorer::Engine.routes.draw do
+  get '*path/download'  => 'application#download', as: :file_download
+  get '*path'  => 'application#index'
+  root to: 'application#index'
+end

data/lib/filesystem-explorer.rb

@@ -0,0 +1,8 @@
+require "filesystem_explorer/engine"
+require 'filesystem_explorer/filesystem_item'
+require 'filesystem_explorer/filesystem_route_options'
+require 'filesystem_explorer/router'
+
+module FilesystemExplorer
+  def self.routes ; @routes ||= [] ; end
+end

data/lib/filesystem_explorer/engine.rb

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

data/lib/filesystem_explorer/filesystem_item.rb

@@ -0,0 +1,168 @@
+module FilesystemExplorer
+  class FilesystemItem
+    attr_reader :root
+    attr_reader :full_path
+
+    def initialize(root, relative_path, options = {})
+      options ||= {}
+      root = [root].flatten
+
+      if root.count > 1
+        relative_path = nil if File.expand_path(relative_path).gsub(/^#{Dir.pwd}\/?/, '').gsub(/^\d+\/?/, '').strip =~ /^\/?$/
+
+        if relative_path.blank?
+          initialize_for_multi_root({ :roots => root })
+        else
+          root.each { |r| relative_path = relative_path.gsub(/^#{r}\/?/, '') }
+          initialize_for_multi_root_child({
+            :roots => root,
+            :index => options[:index] || (relative_path =~ /^(\d+)/ && $1.to_i),
+            :relative_path => relative_path
+          })
+        end
+      else
+        if relative_path.blank?
+          initialize_for_single_root({ :root => root.first })
+        else
+          initialize_for_single_root_child({
+            :root => root.first,
+            :relative_path => relative_path
+          })
+        end
+      end
+    end
+
+    def initialize_for_multi_root(options)
+      @root = options[:roots]
+      @full_paths = @root.map { |r| File.expand_path(r) }
+      @is_directory = @full_paths.all? { |p| File.directory?(p) }
+      @modified_at = nil
+      @size = nil
+      @is_root = true
+      @exists = @full_paths.all? { |p| File.exists?(p) }
+      @is_multi_root = true
+    end
+
+    def initialize_for_multi_root_child(options)
+      @root = options[:roots]
+      @index = options[:index]
+      @path = options[:relative_path]
+      @full_path = File.expand_path(File.join(@root[@index], options[:relative_path].gsub(/^#{options[:index]}\/?/, '')))
+      @exists = File.exists?(@full_path)
+      @name = File.basename(@full_path)
+      @is_directory = @exists && File.directory?(@full_path)
+      @modified_at = @exists && File.mtime(@full_path)
+      @size = @exists && File.size(@full_path)
+      @is_multi_root = true
+      @is_root = false
+      @parent = FilesystemItem.new(@root, build_path(@path, '..'), { :index => options[:index] })
+    end
+
+    def initialize_for_single_root(options)
+      @root = options[:root]
+      @full_path = File.expand_path(@root)
+      @path = '/'
+      @is_directory = File.directory?(@full_path)
+      @modified_at = File.mtime(@full_path)
+      @size = File.size(@full_path)
+      @is_root = true
+      @exists = File.exists?(@full_path)
+      @is_multi_root = false
+    end
+
+    def initialize_for_single_root_child(options)
+      @root = options[:root]
+      @path = options[:relative_path]
+      @full_path = File.expand_path(File.join(@root, @path))
+      @name = File.basename(@full_path)
+      @is_directory = File.directory?(@full_path)
+      @modified_at = File.mtime(@full_path)
+      @size = File.size(@full_path)
+      @is_root = false
+      @exists = File.exists?(@full_path)
+      @is_multi_root = false
+      @parent = FilesystemItem.new(@root, build_path(@path, '..'))
+    end
+
+    def is_directory? ; return @is_directory ; end
+
+    def path ; return @path ||= @full_path || (@full_paths && "") ; end
+    def url ; return @path.split('/').map { |p| URI::escape(p) }.join('/') ; end
+
+    def is_root? ; return @is_root ; end
+    def is_parent? ; return @is_parent || false ; end
+    def exists? ; return @exists ; end
+    def name ; return @name ; end
+    def modified_at(format = nil)
+      return @modified_at if format.blank? || @modified_at.blank?
+      return @modified_at.strftime(format)
+    end
+    def size ; return @size ; end
+
+    def parent
+      return nil if is_root?
+      @parent ||= FilesystemItem.new(@root, File.join(@full_path, '..'), { root: @root })
+    end
+
+    def children
+      return nil unless is_directory?
+      if @children.blank?
+        if @is_multi_root
+          if @is_root
+            load_multi_root_children
+          else
+            load_multi_root_child_children
+          end
+        else
+          load_single_root_children
+        end
+
+        sort_children
+      end
+
+      @children
+    end
+
+    def inspect ; return "[#{is_directory? ? 'D' : 'F'}] #{@full_path}" ; end
+
+    def to_partial_path ; is_directory? ? 'directory' : 'file' ; end
+
+    private
+
+      def load_multi_root_children
+        @children = @is_directory ? @full_paths.each_with_index.map do |r, index|
+          Dir[File.join(Shellwords.escape(r), '*')].map do |f|
+            FilesystemItem.new(@full_paths, f.gsub(/^#{r}/, "#{index}"), :index => index)
+          end
+        end.flatten : []
+      end
+
+      def load_multi_root_child_children
+        @children = @is_directory ? Dir[File.join(Shellwords.escape(@full_path), '*')].map do |f|
+          FilesystemItem.new(@root, f.gsub(/^#{@root[@index]}/, "#{@index}"), :index => @index)
+        end : []
+      end
+
+      def load_single_root_children
+        @children = @is_directory ? Dir[File.join(Shellwords.escape(@full_path), '*')].map do |f|
+          FilesystemItem.new(@root, f.gsub(/^#{@root}\/?/, ''))
+        end : []
+      end
+
+      def sort_children
+        @children.sort! do |a, b|
+          if a.is_directory? && !b.is_directory?
+            -1
+          elsif !a.is_directory? && b.is_directory?
+            1
+          else
+            a.name.downcase <=> b.name.downcase
+          end
+        end
+      end
+
+      def build_path(*args)
+        File.expand_path(File.join(*args)).gsub(/^#{Dir.pwd}\/?/, '')
+      end
+  end
+end

data/lib/filesystem_explorer/filesystem_route_options.rb

@@ -0,0 +1,13 @@
+module FilesystemExplorer
+  class FilesystemRouteOptions
+    %w(as url path).each do |method|
+      attr_reader :"#{method}"
+      instance_variable_set :"@#{method}", nil
+
+      define_method(method) do |value = nil|
+        instance_variable_set :"@#{method}", value if value
+        instance_variable_get :"@#{method}"
+      end
+    end
+  end
+end

data/lib/filesystem_explorer/router.rb

@@ -0,0 +1,51 @@
+module ActionDispatch
+  module Routing
+    class Mapper
+      def filesystem_routes(&block)
+        config_file_path = Rails.root.join('config', 'filesystem_explorer.yml')
+
+        if File.exists?(config_file_path)
+          config_data = YAML.load_file(config_file_path)
+
+          config_data.each do |route|
+            filesystem_explorer path: route[:path] || route['path'], as: route[:as] || route['as'], url: route[:url] || route['url']
+          end
+        end
+
+        block.call($filesystem_explorer_route_options || {}) if block
+      end
+
+      def filesystem_explorer(options = {}, &block)
+        route_config = FilesystemExplorer::FilesystemRouteOptions.new
+
+        # Copy all applicable options from the parameter hash to the object
+        %w(path as url).each do |option|
+          route_config.send option, options[option.to_sym] if options[option.to_sym] && route_config.respond_to?(option)
+        end
+
+        route_config.instance_eval &block if block
+
+        $filesystem_explorer_route_options ||= {}
+        $filesystem_explorer_route_options[route_config.url] ||= route_config
+
+        FilesystemExplorer.routes << route_config
+
+        Rails.application.routes.draw do
+          # Download route
+          route_options = { "#{route_config.url}/*path/download" => "filesystem_explorer/application#download" }
+          route_options[:as] = :"#{route_config.as}_download" if route_config.as
+          get route_options
+
+          # Dynamic route
+          route_options = { "#{route_config.url}/*path" => "filesystem_explorer/application#index" }
+          get route_options
+
+          # Root route
+          route_options = { "#{route_config.url}" => "filesystem_explorer/application#index" }
+          route_options[:as] = :"#{route_config.as}" if route_config.as
+          get route_options
+        end
+      end
+    end
+  end
+end

data/lib/filesystem_explorer/version.rb

@@ -0,0 +1,3 @@
+module FilesystemExplorer
+  VERSION = "0.0.2"
+end

data/lib/tasks/filesystem_explorer_tasks.rake

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