rails_filemanager 1.0 → 1.2

data/README.rdoc

@@ -1,4 +1,82 @@
-= Filemanager
-This is a filemanager for use with CK editor
+= RailsFilemanager
+
+This is a filemanager for ruby on rails.
+It works right away with {CKEditor}[http://ckeditor.com/].
+
+See demo at: http://filemanager-demo.herokuapp.com/filemanager
+
+== Getting Started
+
+1. Add this to your gemfile:
+
+    gem "rails_filemanager"
+
+2. Run the generator:
+
+    rails generate rails_filemanager:install
+    rake db:migrate
+
+3. Now mount the filemanager in your routes:
+
+    # config/routes.rb
+    
+    mount RailsFilemanager::Engine => "/filemanager"
+
+You can now find the filemanager at /filemanager
+
+== Configuration
+
+=== Authorization
+
+Use the method check_authorization to ensure that a user is logged in:
+
+    # config/initializers/rails_filemanager.rb
+
+    def check_authorization
+        raise "unauthorized" unless session[:admin]
+    end
+
+=== Storage
+
+The filemanager uses paperclip for storing the files.
+You can use your own storage options, if you want to use amazon s3 for instance:
+
+    # config/initializers/rails_filemanager.rb
+
+    RailsFilemanager::Engine.config.paperclip_storage_options = {
+        storage: :s3,
+        bucket: "static.example.com",
+        s3_host_alias: "static.example.com",
+        url: ":s3_alias_url",
+        path: ":attachment/:id/:style/:basename.:extension",
+        s3_credentials: {
+            access_key_id: "ACCESSKEY",
+            secret_access_key: "SECRET"
+        }
+    }
+
+=== Translation
+
+The default translation is:
+
+    rails_filemanager:
+      upload: "Upload files"
+      delete: "Delete %{filename}?"
+
+Say, if your app speaks spanish, you could use this example:
+
+    # config/locales/es.yml
+    
+    rails_filemanager:
+      upload: "Upload archivos"
+      delete: "Eliminar %{filename}?"
+
+== Planned features
+
+* Organize in folders
+* Custom javascript callback
+* Adding unit tests
+
+== License
 
 This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -14,7 +14,7 @@ end
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Filemanager'
+  rdoc.title    = 'RailsFilemanager'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/app/assets/javascripts/{filemanager → rails_filemanager}/application.js

@@ -10,5 +10,5 @@
 // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
 // GO AFTER THE REQUIRES BELOW.
 //
-//= require filemanager/jquery.uploadify-3.1.min.js
+//= require rails_filemanager/jquery.uploadify-3.1.min.js
 //= require_tree .

data/app/assets/javascripts/{filemanager/files.js → rails_filemanager/files.js.erb}

@@ -12,9 +12,9 @@ $(document).ready(function()
 
   $('#file_upload').uploadify(
   {
-    swf: "/assets/filemanager/uploadify.swf",
+    swf: "/assets/rails_filemanager/uploadify.swf",
     uploader: $("#file_upload").data("location"),
-    buttonText: "Upload billeder",
+    buttonText: "<%= I18n.t 'rails_filemanager.upload', default: 'Upload files' %>",
     auto: true,
     multi: true,
     formData: SessionParams,
@@ -29,7 +29,7 @@ $(document).ready(function()
     e.preventDefault();
     $this = $(this);
 
-    var deleteImg = confirm("Slet " + $this.data("name") + "?");
+    var deleteImg = confirm("<%= I18n.t 'rails_filemanager.delete', filename: '" + $this.data("name") + "', default: 'Delete %{filename}?' %>");
     if (deleteImg)
     {
       var parent = $this.parent(".file");

data/app/assets/stylesheets/{filemanager → rails_filemanager}/files.css

@@ -46,7 +46,7 @@ body
 	display: none;
 	width: 20px;
 	height: 20px;
-	background-image: url(/assets/filemanager/delete.png);
+	background-image: url(/assets/rails_filemanager/delete.png);
 	position: absolute;
 	top: 0px;
 	right: 0px;

data/app/controllers/rails_filemanager/application_controller.rb

@@ -0,0 +1,8 @@
+module RailsFilemanager
+  class ApplicationController < ActionController::Base
+  	before_filter :check_authorization
+
+  	def check_authorization
+  	end
+  end
+end

data/app/controllers/{filemanager → rails_filemanager}/files_controller.rb

@@ -1,6 +1,6 @@
-require_dependency "filemanager/application_controller"
+require_dependency "rails_filemanager/application_controller"
 
-module Filemanager
+module RailsFilemanager
   class FilesController < ApplicationController
   	def index
 		@User_files = User_file.all

data/app/helpers/{filemanager → rails_filemanager}/application_helper.rb

@@ -1,4 +1,4 @@
-module Filemanager
+module RailsFilemanager
   module ApplicationHelper
   end
 end

data/app/helpers/{filemanager → rails_filemanager}/files_helper.rb

@@ -1,4 +1,4 @@
-module Filemanager
+module RailsFilemanager
   module FilesHelper
   end
 end

data/app/models/{filemanager → rails_filemanager}/user_file.rb

@@ -1,6 +1,6 @@
-module Filemanager
+module RailsFilemanager
   class User_file < ActiveRecord::Base
-    has_attached_file :file, Filemanager::Engine.config.paperclip_storage_options.merge(styles: { thumb: "100x100>" })
+    has_attached_file :file, RailsFilemanager::Engine.config.paperclip_storage_options.merge(styles: { thumb: "100x100>" })
 
     before_post_process :allow_only_images
 
@@ -18,7 +18,7 @@ module Filemanager
 		if self.image?
 			self.file.url(:thumb)
 		else
-			"/assets/filemanager/file.png"
+			"/assets/rails_filemanager/file.png"
 		end
 	end
   end

data/app/views/layouts/{filemanager → rails_filemanager}/application.html.erb

@@ -2,7 +2,7 @@
 <html>
 <head>
   <title>Filemanager</title>
-  <%= stylesheet_link_tag    "filemanager/application.css", :media => "all" %>
+  <%= stylesheet_link_tag    "rails_filemanager/application.css", :media => "all" %>
   <%= csrf_meta_tags %>
 </head>
 <body>
@@ -17,6 +17,6 @@
 </script>
 
 <%= javascript_include_tag "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js" %>
-<%= javascript_include_tag "filemanager/application.js" %>
+<%= javascript_include_tag "rails_filemanager/application.js" %>
 </body>
 </html>

data/config/routes.rb

@@ -1,4 +1,4 @@
-Filemanager::Engine.routes.draw do
+RailsFilemanager::Engine.routes.draw do
 	
 	root to: "files#index"
 

data/lib/generators/rails_filemanager/install/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/migration'
+
+module RailsFilemanager
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "add the migrations and initializers"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_templates
+        template "rails_filemanager.rb", "config/initializers/rails_filemanager.rb"
+        migration_template "create_rails_filemanager_user_files.rb", "db/migrate/create_rails_filemanager_user_files.rb"
+      end
+    end
+  end
+end

data/lib/generators/rails_filemanager/install/templates/create_rails_filemanager_user_files.rb

@@ -0,0 +1,8 @@
+class CreateRailsFilemanagerUserFiles < ActiveRecord::Migration
+  def change
+    create_table :rails_filemanager_user_files do |t|
+    	t.has_attached_file :file
+      t.timestamps
+    end
+  end
+end

data/lib/generators/rails_filemanager/install/templates/rails_filemanager.rb

@@ -0,0 +1,9 @@
+RailsFilemanager::ApplicationController.class_eval do
+	# Use this method to add authorization
+	# def check_authorization
+	# 	raise "unauthorized" unless session[:admin]
+	# end
+end
+
+# Use this to configure storage options for paperclip
+# RailsFilemanager::Engine.config.paperclip_storage_options = {}

data/lib/{filemanager → rails_filemanager}/engine.rb

@@ -1,7 +1,9 @@
-module Filemanager
+require 'paperclip'
+
+module RailsFilemanager
   class Engine < ::Rails::Engine
-    isolate_namespace Filemanager
-    
+    isolate_namespace RailsFilemanager
+
     config.paperclip_storage_options = {}
   end
 end

data/lib/rails_filemanager/version.rb

@@ -0,0 +1,3 @@
+module RailsFilemanager
+  VERSION = "1.2"
+end

data/lib/rails_filemanager.rb

@@ -0,0 +1,4 @@
+require "rails_filemanager/engine"
+
+module RailsFilemanager
+end

data/test/dummy/config/application.rb

@@ -3,7 +3,7 @@ require File.expand_path('../boot', __FILE__)
 require 'rails/all'
 
 Bundler.require
-require "filemanager"
+require "rails_filemanager"
 
 module Dummy
   class Application < Rails::Application

data/test/dummy/config/locales/en.yml

@@ -3,3 +3,6 @@
 
 en:
   hello: "Hello world"
+  # filemanager:
+  #   upload: "Upload filer"
+  #   delete: "Slet %{filename}?"

data/test/dummy/config/routes.rb

@@ -1,4 +1,4 @@
 Rails.application.routes.draw do
 
-  mount Filemanager::Engine => "/filemanager"
+  mount RailsFilemanager::Engine => "/filemanager"
 end