fs_browser 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Andrea Longhi
+
+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,44 @@
+# FileSystem Browser
+
+This is a rails 3 engine that allows your to browse the filesystem via a modal window on the browser, simulating the operative system file open window. It relies on twitter bootstrap modal javascript.
+
+![modal example](https://raw.github.com/spaghetticode/fs_browser/master/docs/modal.jpg "modal example")
+
+## Demo
+
+You can view a demo of the modal window by starting the rails app in ```spec/dummy```.
+
+
+## Usage
+
+Add the gem to your rails app Gemfile:
+
+```ruby
+gem 'fs_browser', :git => 'https://github.com/spaghetticode/fs_browser.git'
+```
+
+Add the gem asset manifests:
+in your rails app application.js add:
+```
+//= require file_browser/application
+```
+same goes in your rails app application.css:
+```
+*= require file_browser/application
+```
+
+Include the modal html in any view of your application:
+```ruby
+<%= render 'file_browser/modal' %>
+```
+
+To start the modal window use the following javascript code:
+```js
+FileBrowser.Modal.init($('#file-browser'));
+```
+
+# TODO
+
+* Integration testing
+* Add configuration for start path
+* Check workings on windows

data/Rakefile

@@ -0,0 +1,29 @@
+#!/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    = 'FileBrowser'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/file_browser/application.js

@@ -0,0 +1,20 @@
+// 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 handlebars
+//= require bootstrap
+//= require ./modal
+//= require ./path
+//= require ./entry
+//= require_tree .

data/app/assets/javascripts/file_browser/entry.js.coffee

@@ -0,0 +1,49 @@
+class FileBrowser.Entry
+  @FILE      = 'file'
+  @DIRECTORY = 'directory'
+  @FLASH     = ['flv', 'swf']
+  @VIDEO     = ['mov', 'avi', 'wmv', 'mp4', 'mkv', 'm4v']
+  @AUDIO     = ['mp3', 'ogg', 'wav', 'cue', 'm4a']
+  @IMAGE     = ['png', 'jpg', 'jpeg', 'gif', 'bmp']
+  @KNOWN     = ['rb', 'js', 'css', 'pdf', 'php', 'ppt', 'psd', 'txt', 'zip', 'doc', 'exe', 'xls', 'java']
+
+  @all: []
+
+  @build: (json) ->
+    @all = []
+    @all.push(new @ entry) for entry in json
+
+
+
+  constructor: (json) ->
+    @name    = json.name
+    @type    = json.type
+    @ext     = json.ext
+    @icon    = @_getIcon()
+    @element = @_buildElement()
+    @_bindClick()
+    @_bindDblClick()
+
+  isFile:      -> @type is @constructor.FILE
+  isDirectory: -> @type is @constructor.DIRECTORY
+  extChars:    -> if @ext then @ext[1..] else 'unk'
+
+  _getIcon: -> "/assets/file_browser/file_icons/#{@_iconName()}.png"
+
+  _iconName: ->
+    return 'folder'    if @isDirectory()
+    return 'audio'     if @_inArray('AUDIO')
+    return 'video'     if @_inArray('VIDEO')
+    return 'image'     if @_inArray('IMAGE')
+    return 'flash'     if @_inArray('FLASH')
+    return @extChars() if @_inArray('KNOWN')
+    'file'
+
+  _inArray: (name) ->
+    @constructor[name].indexOf(@extChars()) >= 0
+
+  _bindClick: -> FileBrowser.Modal.handleEntryClick(@)
+
+  _bindDblClick: -> FileBrowser.Modal.handleEntryDblClick(@)
+
+  _buildElement: -> FileBrowser.Modal.buildEntryElement(@)

data/app/assets/javascripts/file_browser/modal.js.coffee

@@ -0,0 +1,48 @@
+window.FileBrowser = {}
+
+class FileBrowser.Modal
+  @init: (@element) ->
+    @list = @element.find('ul')
+    @element.modal
+      keyboard: true
+      show:     false
+    @element.on 'show', -> FileBrowser.Path.getJson()
+    @element.modal 'show'
+
+  @clearList: -> @list.html ''
+
+  @update: ->
+    @buildEntryList()
+    @updatePath()
+
+  @buildEntryList: ->
+    @clearList()
+    for entry in FileBrowser.Entry.all
+      @list.append(entry.element)
+
+  @handleEntryClick: (entry) ->
+      element = entry.element
+      element.click =>
+        $('.entry').removeClass('selected')
+        element.addClass('selected')
+        @updatePath entry.name
+
+  @handleEntryDblClick: (entry) ->
+    element = entry.element
+    element.dblclick =>
+      if entry.type is FileBrowser.Entry.DIRECTORY
+        FileBrowser.Path.update entry.name
+        @updatePath()
+      else
+        alert entry.type
+
+  @buildEntryElement: (entry) ->
+    $(JST['file_browser/templates/file_browser/entry'](entry))
+
+  @updatePath: (name) ->
+    dirty = [@currentPath(), name].join @separator()
+    clean = dirty.replace new RegExp("#{@separator()}#{@separator()}"), @separator()
+    $('#path').val clean
+
+  @currentPath: -> FileBrowser.Path.current()
+  @separator : -> FileBrowser.Path.separator

data/app/assets/javascripts/file_browser/path.js.coffee

@@ -0,0 +1,30 @@
+class FileBrowser.Path
+  @tree = []
+  @separator = '/'
+
+  @getJson: =>
+    $.ajax
+      type:     'POST'
+      dataType: 'json'
+      url:      '/file_browser/paths'
+      data:     {id: @current()}
+      success:  @build
+
+  @current: =>
+    if @tree.length then @tree.join(@separator) else 'root'
+
+  @parent: ->
+    @tree.pop()
+    @current()
+
+  @build: (json) =>
+    @tree.push json.name unless @tree.length
+    FileBrowser.Entry.build(json.entries)
+    FileBrowser.Modal.update()
+
+  @update: (entryName) ->
+    if entryName is '..'
+      @parent()
+    else
+      @tree.push entryName
+    @getJson()

data/app/assets/javascripts/file_browser/templates/file_browser/entry.jst.hjs

@@ -0,0 +1 @@
+<li class="entry" data-type="{{type}}"><img src="{{icon}}" alt="">{{name}}</li>

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

@@ -0,0 +1,14 @@
+/*
+ * 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 .
+ *= require ./bootstrap_override
+ */

data/app/assets/stylesheets/file_browser/bootstrap_override.css.scss

@@ -0,0 +1 @@
+@import "bootstrap";

data/app/assets/stylesheets/file_browser/modal.css.scss

@@ -0,0 +1,32 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+#file-browser {
+  .modal-header {
+    .close {
+      margin-top: 13px;
+    }
+    input {
+      width: 93%;
+      display: block;
+      margin-top:10px;
+    }
+  }
+  .modal-body {
+    ul {
+      width: 90%;
+      height: 200px;
+      list-style-type: none;
+    }
+    .entry {
+      img {
+        padding: 3px 6px;
+      }
+      &.selected {
+        background: #99CCFF;
+      }
+    }
+  }
+}

data/app/controllers/file_browser/application_controller.rb

@@ -0,0 +1,4 @@
+module FileBrowser
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/file_browser/paths_controller.rb

@@ -0,0 +1,19 @@
+require_dependency "file_browser/application_controller"
+
+module FileBrowser
+  class PathsController < ApplicationController
+    respond_to :json
+
+    def create
+      @path = Path.new(path_name)
+      # respond_with @path
+      render :json => @path
+    end
+
+    private
+
+    def path_name
+      Path.name_from_params(params)
+    end
+  end
+end

data/app/helpers/file_browser/application_helper.rb

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

data/app/models/file_browser/entry.rb

@@ -0,0 +1,40 @@
+module FileBrowser
+  class Entry
+    FILE      = 'file'
+    DIRECTORY = 'directory'
+    TYPES     = [DIRECTORY, FILE]
+
+    attr_reader :name, :type, :ext, :path
+
+    def initialize(path)
+      @path = path
+      @name = get_name
+      @type = get_type
+      @ext  = get_ext
+    end
+
+    TYPES.each do |method_name|
+      define_method "#{method_name}?" do
+        self.class.const_get("#{method_name}".upcase) == type
+      end
+    end
+
+    def as_json(opts={})
+      {'name' => name, 'type' => type, 'path' => path, 'ext' => ext}
+    end
+
+    private
+
+    def get_name
+      File.basename(path)
+    end
+
+    def get_type
+      TYPES.detect { |type| File.send("#{type}?", path) }
+    end
+
+    def get_ext
+      File.extname(name).downcase if file?
+    end
+  end
+end

data/app/models/file_browser/path.rb

@@ -0,0 +1,51 @@
+module FileBrowser
+  class Path
+    class NotFoundError < Exception; end
+    BASE = '/'
+
+    class << self
+      attr_writer :base
+
+      def base
+        @base ||= BASE
+      end
+    end
+
+    attr_reader :name, :entries
+
+    def self.name_from_params(params)
+      name = params[:id]
+      name == 'root' ? base : name
+    end
+
+    def initialize(name)
+      validate(name)
+      @name    = name
+      @entries = get_entries
+    end
+
+    def get_entries
+      file_list.map do |entry_name|
+        Entry.new(entry_name)
+      end
+    end
+
+    def file_list
+      list = Dir.glob("#{name}/*")
+      list.unshift '..' unless root?
+      list
+    end
+
+    def root?
+      name == base
+    end
+
+    def base
+      self.class.base
+    end
+
+    def validate(name)
+      raise NotFoundError unless File.exists?(name)
+    end
+  end
+end

data/app/views/file_browser/_modal.html.haml

@@ -0,0 +1,9 @@
+#file-browser.modal.hide.fade
+  .modal-header
+    %button.close{:type=>"button", 'data-dismiss'=>"modal", 'aria-hidden'=>"true"}×
+    %input{:type => 'text', :disabled => 'disabled', :id => 'path', :name => 'path'}
+  .modal-body
+    %ul
+  .modal-footer
+    %button.btn{'data-dismiss'=>"modal", 'aria-hidden'=>"true"} Cancel
+    %button.btn.btn-primary Open

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>FileBrowser</title>
+  <%= stylesheet_link_tag    "file_browser/application", :media => "all" %>
+  <%= javascript_include_tag "file_browser/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+FileBrowser::Engine.routes.draw do
+  resources :paths, :only => :create
+end

data/lib/file_browser.rb

@@ -0,0 +1,4 @@
+require "file_browser/engine"
+
+module FileBrowser
+end

data/lib/file_browser/engine.rb

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

data/lib/file_browser/version.rb

@@ -0,0 +1,3 @@
+module FileBrowser
+  VERSION = "0.0.1"
+end

data/lib/tasks/file_browser_tasks.rake

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

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: fs_browser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrea Longhi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: rails 3 engine to create a modal window to browse the server file system
+email:
+- andrea@spaghetticode.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/images/file_browser/file_icons/audio.png
+- app/assets/images/file_browser/file_icons/code.png
+- app/assets/images/file_browser/file_icons/css.png
+- app/assets/images/file_browser/file_icons/db.png
+- app/assets/images/file_browser/file_icons/doc.png
+- app/assets/images/file_browser/file_icons/exe.png
+- app/assets/images/file_browser/file_icons/file.png
+- app/assets/images/file_browser/file_icons/flash.png
+- app/assets/images/file_browser/file_icons/folder.png
+- app/assets/images/file_browser/file_icons/folder_open.png
+- app/assets/images/file_browser/file_icons/html.png
+- app/assets/images/file_browser/file_icons/image.png
+- app/assets/images/file_browser/file_icons/java.png
+- app/assets/images/file_browser/file_icons/js.png
+- app/assets/images/file_browser/file_icons/linux.png
+- app/assets/images/file_browser/file_icons/pdf.png
+- app/assets/images/file_browser/file_icons/php.png
+- app/assets/images/file_browser/file_icons/ppt.png
+- app/assets/images/file_browser/file_icons/psd.png
+- app/assets/images/file_browser/file_icons/rb.png
+- app/assets/images/file_browser/file_icons/spinner.gif
+- app/assets/images/file_browser/file_icons/txt.png
+- app/assets/images/file_browser/file_icons/video.png
+- app/assets/images/file_browser/file_icons/xls.png
+- app/assets/images/file_browser/file_icons/zip.png
+- app/assets/javascripts/file_browser/application.js
+- app/assets/javascripts/file_browser/entry.js.coffee
+- app/assets/javascripts/file_browser/modal.js.coffee
+- app/assets/javascripts/file_browser/path.js.coffee
+- app/assets/javascripts/file_browser/templates/file_browser/entry.jst.hjs
+- app/assets/stylesheets/file_browser/application.css
+- app/assets/stylesheets/file_browser/bootstrap_override.css.scss
+- app/assets/stylesheets/file_browser/modal.css.scss
+- app/controllers/file_browser/application_controller.rb
+- app/controllers/file_browser/paths_controller.rb
+- app/helpers/file_browser/application_helper.rb
+- app/models/file_browser/entry.rb
+- app/models/file_browser/path.rb
+- app/views/file_browser/_modal.html.haml
+- app/views/layouts/file_browser/application.html.erb
+- config/routes.rb
+- lib/file_browser/engine.rb
+- lib/file_browser/version.rb
+- lib/file_browser.rb
+- lib/tasks/file_browser_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/spaghetticode/fs_browser
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -783945965777440577
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -783945965777440577
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: rails 3 engine to create a modal window to browse the server file system
+test_files: []