has_media 0.1.3 → 0.2.1

data/.gitignore

@@ -20,3 +20,4 @@ pkg
 
 ## PROJECT::SPECIFIC
 uploads
+doc

data/README.rdoc

@@ -4,53 +4,83 @@ Media Managment Library for ActiveRecord and Carrierwave
 
 Easy way to link media (ie image, audio, video, pdf, ...) on other activerecords models
 
-Use branch rails2.3 for Rails 2.3.x and rails3 for Rails 3
+Use branch rails2.3 for Rails 2.3.x (gem install has_media -v=v0.1.3) 
 
-=== Create migrations
+Use branch rails3 for Rails 3 (gem install has_media)
 
-./script/generate has_media
+== Installation
 
-== Usage
+=== Rails 2.3.x
 
-  has_one_medium  :image, :only => :image
-  has_many_media  :images, :only => :image
+see http://github.com/klacointe/has_media/tree/rails2.3
 
-  has_one_medium  :audio, :only => :audio
-  has_many_media  :audios, :only => :audio
+=== Rails 3
 
-  has_one_medium  :image_no_encode, :only => :image, :encode => false
+- gem install has_media
+- rails generate has_media:install
 
-  has_one_medium  :pdf, :encode => false
+The generator will create :
+- migration for activerecord
+- initializer for HasMedia configuration
+- locales files
 
 == Model and Uploaders
 
-You must defined model and uploader with the name given in the only option
+You must defined model and uploader with the name given in the :only option
+
 Examples are in the /examples directory...
 
+== Usage
+
+Available methods are :
+- has_one_medium : Link to one medium
+- has_many_media : Link to many media
+
+Available options are :
+- only : restrict medium type to link on
+- encode : if false is given, set the encode status of this medium 
+  to NO_ENCODING instead of ENCODE_WAIT, default to true
+
+Example :
+
+  class MyModelWithMedia < ActiveRecord::Base
+
+    has_one_medium  :image, :only => :image
+    has_many_media  :images, :only => :image
+
+    has_one_medium  :audio, :only => :audio
+    has_many_media  :audios, :only => :audio
+
+    has_one_medium  :image_no_encode, :only => :image, :encode => false
+
+    has_one_medium  :pdf, :encode => false
+
+  end
+
 == Configuration
 
- * Configuration take place in config/initializers/has_media.rb
+Configuration take place in config/initializers/has_media.rb
 
- * Set the directory path to use to store media
+  # Set the directory path to use to store media
   HasMedia.directory_path = "media"
 
- * Set the base uri to access media
+  # Set the base uri to access media
   HasMedia.directory_uri = "/media"
 
- * Set custom error messages
+  # Set custom error messages
   HasMedia.errors_messages = {:type_error => I18n.t('has_media.errors.type_error')}
 
- * Set the allowed medium types for your application (used if no :only option given)
+  # Set the allowed medium types for your application (used if no :only option given)
   HasMedia.medium_types = [Image, Video, Audio]
 
- * Set the extension of encoded files to use for each medium types (used in file_uri and file_path)
+  # Set the extension of encoded files to use for each medium types (used in file_uri and file_path)
   HasMedia.encoded_extensions = {
     :image => 'png',
     :audio => 'ogg',
     :video => 'flv'
   }
 
- * Require you uploaders 
+  # Require you uploaders 
   Dir.glob(File.dirname(__FILE__) + '/../app/uploaders/*.rb').each do |uploader|
     require uploader
   end
@@ -68,13 +98,14 @@ Factory example using factory_girl :
     f.file {ActionController::TestUploadedFile.new(File.join(Rails.root, '/spec/factories/image.jpg'), 'image/jpeg')}
   end
 
-== TODO 
- * Doc for testing (ActionController::TestUploadedFile is now obsolete in rails 3), add HasMediaTestHelper with stub_temp_file method
- * Generator for initializer
- * Add controller and views examples with overload system (form fields, display, ...)
- * Fix problem with migrations generator timestamps
- * Generator for models and uploaders (Type in Image, Video, Audio, Pdf) :
-  rails generate has_media_model Type Name
+== Todo
+- Doc for testing (ActionController::TestUploadedFile is now obsolete in rails 3), add HasMediaTestHelper with stub_temp_file method
+- Generator for initializer
+- Add controller and views examples with overload system (form fields, display, ...)
+- Fix problem with migrations generator timestamps
+- Generator for models and uploaders (Type in Image, Video, Audio, Pdf) : rails generate has_media_model Type Name
+- Document code
+- add example app on github
 
 == Contributors
 

data/Rakefile

@@ -15,11 +15,11 @@ begin
     gem.email = "kevinlacointe@gmail.com"
     gem.homepage = "http://github.com/klacointe/has_media"
     gem.authors = ["klacointe", "spk"]
-    gem.add_development_dependency "rspec", "<=1.3.0"
-    gem.add_dependency('carrierwave', '=0.4.5')
-    gem.add_dependency('activerecord', '=2.3.8')
-    gem.add_dependency('activesupport', '=2.3.8')
-    gem.add_dependency('mime-types', '>=1.16')
+    gem.add_development_dependency "rspec", "~>2.0.0"
+    gem.add_dependency('carrierwave-rails3', '~>0.4.5')
+    gem.add_dependency('activerecord', '~>3.0.0')
+    gem.add_dependency('activesupport', '~>3.0.0')
+    gem.add_dependency('mime-types', '~>1.16')
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.1

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  has_media:
+    errors:
+      type_error: "File type error"

data/has_media.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{has_media}
-  s.version = "0.1.3"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["klacointe", "spk"]
-  s.date = %q{2010-10-06}
+  s.date = %q{2010-11-02}
   s.description = %q{Media Managment Library for ActiveRecord and Carrierwave}
   s.email = %q{kevinlacointe@gmail.com}
   s.extra_rdoc_files = [
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "config/locales/en.yml",
      "examples/models/audio.rb",
      "examples/models/image.rb",
      "examples/models/pdf.rb",
@@ -32,10 +33,12 @@ Gem::Specification.new do |s|
      "examples/uploaders/image_uploader.rb",
      "examples/uploaders/pdf_uploader.rb",
      "examples/uploaders/video_uploader.rb",
-     "generators/has_media/has_media_generator.rb",
-     "generators/has_media/templates/create_media.rb",
-     "generators/has_media/templates/create_media_links.rb",
      "has_media.gemspec",
+     "lib/generators/active_record/has_media_generator.rb",
+     "lib/generators/active_record/templates/migration.rb",
+     "lib/generators/has_media/install_generator.rb",
+     "lib/generators/templates/README",
+     "lib/generators/templates/has_media.rb",
      "lib/has_media.rb",
      "lib/has_media/models/media_link.rb",
      "lib/has_media/models/medium.rb",
@@ -58,17 +61,17 @@ Gem::Specification.new do |s|
   s.summary = %q{Media Managment Library for ActiveRecord and Carrierwave}
   s.test_files = [
     "spec/spec_helper.rb",
-     "spec/fixtures/models/image.rb",
-     "spec/fixtures/uploaders/uploader_with_exception.rb",
      "spec/has_media_spec.rb",
+     "spec/fixtures/uploaders/uploader_with_exception.rb",
+     "spec/fixtures/models/image.rb",
+     "examples/uploaders/image_uploader.rb",
+     "examples/uploaders/pdf_uploader.rb",
+     "examples/uploaders/video_uploader.rb",
+     "examples/uploaders/audio_uploader.rb",
      "examples/models/image.rb",
      "examples/models/pdf.rb",
      "examples/models/audio.rb",
-     "examples/models/video.rb",
-     "examples/uploaders/pdf_uploader.rb",
-     "examples/uploaders/audio_uploader.rb",
-     "examples/uploaders/video_uploader.rb",
-     "examples/uploaders/image_uploader.rb"
+     "examples/models/video.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -76,24 +79,24 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["<= 1.3.0"])
-      s.add_runtime_dependency(%q<carrierwave>, ["= 0.4.5"])
-      s.add_runtime_dependency(%q<activerecord>, ["= 2.3.8"])
-      s.add_runtime_dependency(%q<activesupport>, ["= 2.3.8"])
-      s.add_runtime_dependency(%q<mime-types>, [">= 1.16"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0"])
+      s.add_runtime_dependency(%q<carrierwave-rails3>, ["~> 0.4.5"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<mime-types>, ["~> 1.16"])
     else
-      s.add_dependency(%q<rspec>, ["<= 1.3.0"])
-      s.add_dependency(%q<carrierwave>, ["= 0.4.5"])
-      s.add_dependency(%q<activerecord>, ["= 2.3.8"])
-      s.add_dependency(%q<activesupport>, ["= 2.3.8"])
-      s.add_dependency(%q<mime-types>, [">= 1.16"])
+      s.add_dependency(%q<rspec>, ["~> 2.0.0"])
+      s.add_dependency(%q<carrierwave-rails3>, ["~> 0.4.5"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_dependency(%q<mime-types>, ["~> 1.16"])
     end
   else
-    s.add_dependency(%q<rspec>, ["<= 1.3.0"])
-    s.add_dependency(%q<carrierwave>, ["= 0.4.5"])
-    s.add_dependency(%q<activerecord>, ["= 2.3.8"])
-    s.add_dependency(%q<activesupport>, ["= 2.3.8"])
-    s.add_dependency(%q<mime-types>, [">= 1.16"])
+    s.add_dependency(%q<rspec>, ["~> 2.0.0"])
+    s.add_dependency(%q<carrierwave-rails3>, ["~> 0.4.5"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+    s.add_dependency(%q<mime-types>, ["~> 1.16"])
   end
 end
 

data/lib/generators/active_record/has_media_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    # Cannot inhérit from ActiveRecord::Generators::Base 
+    # see http://groups.google.com/group/rubyonrails-talk/browse_thread/thread/a507ce419076cda2
+    class HasMediaGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_has_media_migration
+        migration_template "migration.rb", "db/migrate/has_media"
+      end
+
+      # Implement the required interface for Rails::Generators::Migration.
+      # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+    end
+  end
+end

data/{generators/has_media/templates/create_media.rb → lib/generators/active_record/templates/migration.rb}

@@ -1,4 +1,4 @@
-class CreateMedia < ActiveRecord::Migration
+class HasMedia < ActiveRecord::Migration
   def self.up
     create_table :media do |t|
       t.integer  :width
@@ -16,9 +16,20 @@ class CreateMedia < ActiveRecord::Migration
     end
     add_index :media, :encode_status
     add_index :media, [:type, :context]
+
+    create_table :media_links do |t|
+      t.integer :medium_id     # required
+      t.integer :mediated_id   # required
+      t.string  :mediated_type # required
+
+      t.timestamps
+    end
+    add_index :media_links, :medium_id
+    add_index :media_links, [:mediated_id, :mediated_type]
   end
 
   def self.down
     drop_table :media
+    drop_table :media_links
   end
 end

data/lib/generators/has_media/install_generator.rb

@@ -0,0 +1,24 @@
+module HasMedia
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a HasMedia initializer, migration and copy locale files to your application."
+
+      def copy_initializer
+        template "has_media.rb", "config/initializers/has_media.rb"
+      end
+
+      def copy_locale
+        copy_file "../../../config/locales/en.yml", "config/locales/has_media.en.yml"
+      end
+
+      hook_for :orm, :as => "has_media"
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,5 @@
+===============================================================================
+Thanks for using HasMedia !
+
+Documentation available at http://github.com/klacointe/has_media
+===============================================================================

data/lib/generators/templates/has_media.rb

@@ -0,0 +1,20 @@
+# Set the directory path to use to store media
+HasMedia.directory_path = "media"
+
+# Set the base uri to access media
+HasMedia.directory_uri = "/media"
+
+# Set the allowed medium types for your application (used if no :only option given)
+#HasMedia.medium_types = [Image, Video, Audio]
+
+# Set the extension of encoded files to use for each medium types (used in file_uri and file_path)
+#HasMedia.encoded_extensions = {
+#  :image => 'png',
+#  :audio => 'ogg',
+#  :video => 'flv'
+#}
+
+# Require you uploaders
+Dir.glob(File.dirname(__FILE__) + '/../app/uploaders/*.rb').each do |uploader|
+  require uploader
+end

data/lib/has_media/models/medium.rb

@@ -31,7 +31,7 @@ class Medium < ActiveRecord::Base
   after_initialize  :set_default_encoding_status
 
 
-  named_scope :with_context, lambda {|context|
+  scope :with_context, lambda {|context|
     { :conditions => { :context => context.to_s} }
   }
 

data/spec/spec_helper.rb

@@ -11,10 +11,9 @@ require 'action_dispatch/testing/test_process'
 require 'has_media'
 
 dbconfig = {
-  :adapter => 'mysql',
-  :database => 'has_media',
-  :username => 'test',
-  :password => 'test'
+  :adapter => 'sqlite3',
+  :database => ':memory:',
+#  :database => 'has_media.sqlite'
 }
 
 ActiveRecord::Base.establish_connection(dbconfig)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_media
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 21
   prerelease: false
   segments: 
   - 0
+  - 2
   - 1
-  - 3
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors: 
 - klacointe
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-06 00:00:00 +02:00
+date: 2010-11-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,23 +25,23 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - <=
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 15
         segments: 
-        - 1
-        - 3
+        - 2
         - 0
-        version: 1.3.0
+        - 0
+        version: 2.0.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: carrierwave
+  name: carrierwave-rails3
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 5
         segments: 
@@ -57,14 +57,14 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 7
         segments: 
-        - 2
         - 3
-        - 8
-        version: 2.3.8
+        - 0
+        - 0
+        version: 3.0.0
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -73,14 +73,14 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 7
         segments: 
-        - 2
         - 3
-        - 8
-        version: 2.3.8
+        - 0
+        - 0
+        version: 3.0.0
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -89,7 +89,7 @@ dependencies:
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 47
         segments: 
@@ -115,6 +115,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- config/locales/en.yml
 - examples/models/audio.rb
 - examples/models/image.rb
 - examples/models/pdf.rb
@@ -123,10 +124,12 @@ files:
 - examples/uploaders/image_uploader.rb
 - examples/uploaders/pdf_uploader.rb
 - examples/uploaders/video_uploader.rb
-- generators/has_media/has_media_generator.rb
-- generators/has_media/templates/create_media.rb
-- generators/has_media/templates/create_media_links.rb
 - has_media.gemspec
+- lib/generators/active_record/has_media_generator.rb
+- lib/generators/active_record/templates/migration.rb
+- lib/generators/has_media/install_generator.rb
+- lib/generators/templates/README
+- lib/generators/templates/has_media.rb
 - lib/has_media.rb
 - lib/has_media/models/media_link.rb
 - lib/has_media/models/medium.rb
@@ -177,14 +180,14 @@ specification_version: 3
 summary: Media Managment Library for ActiveRecord and Carrierwave
 test_files: 
 - spec/spec_helper.rb
-- spec/fixtures/models/image.rb
-- spec/fixtures/uploaders/uploader_with_exception.rb
 - spec/has_media_spec.rb
+- spec/fixtures/uploaders/uploader_with_exception.rb
+- spec/fixtures/models/image.rb
+- examples/uploaders/image_uploader.rb
+- examples/uploaders/pdf_uploader.rb
+- examples/uploaders/video_uploader.rb
+- examples/uploaders/audio_uploader.rb
 - examples/models/image.rb
 - examples/models/pdf.rb
 - examples/models/audio.rb
 - examples/models/video.rb
-- examples/uploaders/pdf_uploader.rb
-- examples/uploaders/audio_uploader.rb
-- examples/uploaders/video_uploader.rb
-- examples/uploaders/image_uploader.rb

data/generators/has_media/has_media_generator.rb

@@ -1,8 +0,0 @@
-class HasMediaGenerator < Rails::Generator::Base
-  def manifest
-    record do |m|
-      m.migration_template('create_media.rb', 'db/migrate', :migration_file_name => 'create_media')
-      m.migration_template('create_media_links.rb', 'db/migrate', :migration_file_name => 'create_media_links')
-    end
-  end
-end

data/generators/has_media/templates/create_media_links.rb

@@ -1,17 +0,0 @@
-class CreateMediaLinks < ActiveRecord::Migration
-  def self.up
-    create_table :media_links do |t|
-      t.integer :medium_id     # required
-      t.integer :mediated_id   # required
-      t.string  :mediated_type # required
-
-      t.timestamps
-    end
-    add_index :media_links, :medium_id
-    add_index :media_links, [:mediated_id, :mediated_type]
-  end
-
-  def self.down
-    drop_table :media_links
-  end
-end