active_musicbrainz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7323c327554fad6ca29c48a436a51bda55400783
+  data.tar.gz: 5a9515e43385659163c972b01d05c19a60c9654c
+SHA512:
+  metadata.gz: 27907fad9a780d541a4147babe2ba90b1c63953ebc5eedd4d6062635a9a266ae51f66c1973aa83ec161ff1633936d882815a1e023c0d404fcb4b488f833fdebf
+  data.tar.gz: f45004a93a5582db123168de9e09a43527a5f428fecc094927e77f147acadd81cf0258b915451c938490b69f0edd484b2553a21c5a22a744b80fbe48df369623

data/.gitignore

@@ -0,0 +1,5 @@
+*.swp
+.DS_Store
+pkg
+Gemfile.lock
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrea Franz (http://gravityblast.com)
+
+MIT License
+
+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,74 @@
+# ActiveMusicbrainz
+
+ActiveRecord models for the [MusicBrainz](http://musicbrainz.org/) [database](http://musicbrainz.org/doc/MusicBrainz_Database).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_musicbrainz'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_musicbrainz
+
+## Usage
+
+Require ActiveMusicbrainz and initialize the database **(if you are inside a rails app, you can skip the following lines)**:
+
+    require 'active_musicbrainz'
+    ActiveRecord::Base.establish_connection(YAML.load_file('path/to/config.yml'))
+
+Some models are hardcoded, others are dynamically generated based on existing tables. You can initialize all those models with the following line:
+
+    ActiveMusicbrainz.init
+
+The *init* method should be called after establishing a database connection since the library needs to read all the database tables.
+If you are inside a rails project you could put the code above in **config/initializers/active_musicbrainz.rb**.
+
+Now under the ActiveMusicbrainz::Model module, you have one model for each MusicBrainz table.
+Here some examples:
+
+    artist = ActiveMusicbrainz::Model::Artist.where(gid: '9a709693-b4f8-4da9-8cc1-038c911a61be').first
+     => #<ActiveMusicbrainz::Model::Artist id: 24146, gid: "9a709693-b4f8-4da9-8cc1-038c911a61be", name: 143497, sort_name: 143497, begin_date_year: 1976, begin_date_month: 3, begin_date_day: 30, end_date_year: nil, end_date_month: nil, end_date_day: nil, type: 1, area: 221, gender: 1, comment: "UK electro artist Simon Green", edits_pending: 0, last_updated: "2013-05-13 11:00:09", ended: false, begin_area: nil, end_area: nil>
+
+    artist.name
+     => "Bonobo"
+
+    artist.release_groups.first.type
+     => #<ActiveMusicbrainz::Model::ReleaseGroupPrimaryType id: 1, name: "Album">
+
+    artist.release_groups.each{|r| puts r.name }
+      Black Sands
+      Dial 'M' for Monkey
+      Scuba EP
+      Flutter
+      Pick Up
+      Terrapin
+      Eyesdown
+      ...
+
+    artist.release_groups.first.releases.first.mediums
+     => [#<ActiveMusicbrainz::Model::Medium id: 654199, release: 654199, position: 1, format: 1, name: nil, edits_pending: 0, last_updated: "2012-01-15 13:46:18", track_count: 12>]
+
+    artist.release_groups.first.releases.first.mediums.first.tracks.each{|t| puts t.name}
+      Prelude
+      Kiara
+      Kong
+      Eyesdown
+      ...
+
+    artist.release_groups.first.releases.first.mediums.first.format
+     => #<ActiveMusicbrainz::Model::MediumFormat id: 1, name: "CD", parent: nil, child_order: 0, year: 1982, has_discids: true>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/active_musicbrainz.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_musicbrainz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_musicbrainz"
+  spec.version       = ActiveMusicbrainz::VERSION
+  spec.authors       = ["Andrea Franz"]
+  spec.email         = ["andrea@gravityblast.com"]
+  spec.description   = %q{ActiveRecord models for the MusicBrainz database.}
+  spec.summary       = %q{ActiveRecord models the MusicBrainz database}
+  spec.homepage      = "https://github.com/pilu/active_musicbrainz"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'activerecord'
+end

data/lib/active_musicbrainz.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'active_musicbrainz/version'
+require 'active_musicbrainz/config'
+require 'active_musicbrainz/models/base'
+require 'active_musicbrainz/models/factory'
+require 'active_musicbrainz/models/model'
+
+module ActiveMusicbrainz
+  def self.init
+    Model.build_models
+  end
+end
+

data/lib/active_musicbrainz/config.rb

@@ -0,0 +1,19 @@
+require 'yaml'
+
+module ActiveMusicbrainz
+  class Config
+    class << self
+      def load config_path
+        self.config = YAML.load_file config_path
+      end
+
+      def config= config
+        @config = config
+      end
+
+      def database
+        @config[:database]
+      end
+    end
+  end
+end

data/lib/active_musicbrainz/models/base.rb

@@ -0,0 +1,23 @@
+module ActiveMusicbrainz
+  module Model
+    module Base
+      def self.included base
+        base.send :extend, ClassMethods
+      end
+
+      module ClassMethods
+        def has_name association_name
+          define_method :name do
+            send(association_name).name
+          end
+        end
+
+        def has_artist_credits
+          belongs_to  :artist_credit, foreign_key: :artist_credit
+          has_many    :artist_credit_names, through: :artist_credit
+          has_many    :artists, through: :artist_credit_names
+        end
+      end
+    end
+  end
+end

data/lib/active_musicbrainz/models/factory.rb

@@ -0,0 +1,40 @@
+module ActiveMusicbrainz
+  module Model
+    class Factory
+      def self.define &block
+        factory = new
+        factory.instance_eval &block if block_given?
+        factory
+      end
+
+      def model table_name, &block
+        klass = model_class table_name
+        klass.class_eval &block if block_given?
+        klass
+      end
+
+      private
+
+      def camelize_table_name(term, uppercase_first_letter = true)
+        string = term.to_s
+        string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+        string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
+      end
+
+      def model_class table_name
+        Model.const_get camelize_table_name(table_name)
+      rescue NameError
+        build_model_class table_name
+      end
+
+      def build_model_class table_name
+        klass = Class.new ActiveRecord::Base do
+          self.table_name = table_name
+          self.inheritance_column = :_sti_type
+          include Base
+        end
+        Model.const_set camelize_table_name(table_name), klass
+      end
+    end
+  end
+end

data/lib/active_musicbrainz/models/model.rb

@@ -0,0 +1,111 @@
+module ActiveMusicbrainz
+  module Model
+    def self.build_models
+      Factory.define do
+        ActiveRecord::Base.connection.tables.each do |table_name|
+          model table_name
+        end
+      end
+      true
+    end
+
+    Factory.define do
+      model :artist do
+        belongs_to  :artist_name, foreign_key: :name
+        has_many    :artist_credit_name, foreign_key: :artist
+        has_many    :artist_credits, through: :artist_credit_name
+        has_many    :release_groups, through: :artist_credits
+        has_many    :releases, through: :release_groups
+        has_many    :recordings, through: :artist_credits
+        has_many    :tracks, through: :artist_credits
+        has_many    :aliases, foreign_key: :artist
+        has_name    :artist_name
+      end
+
+      model :artist_credit_name do
+        belongs_to  :artist_credit, foreign_key: :artist_credit
+        belongs_to  :artist_name, foreign_key: :name
+        belongs_to  :artist, foreign_key: :artist
+        has_name    :artist_name
+      end
+
+      model :artist_credit do
+        belongs_to  :artist_name, foreign_key: :name
+        has_many    :artist_credit_names, foreign_key: :artist_credit
+        has_many    :artists, through: :artist_credit_names
+        has_many    :recordings, foreign_key: :artist_credit
+        has_many    :tracks, foreign_key: :artist_credit
+        has_many    :releases, foreign_key: :artist_credit
+        has_many    :release_groups, foreign_key: :artist_credit
+        has_name    :artist_name
+      end
+
+      model :artist_alias do
+        belongs_to  :artist_name, foreign_key: :name
+        belongs_to  :artist, foreign_key: :artist
+        has_name    :artist_name
+      end
+
+      model :track do
+        belongs_to  :track_name, foreign_key: :name
+        belongs_to  :recording, foreign_key: :recording
+        belongs_to  :medium, foreign_key: :medium
+        has_name    :track_name
+        has_artist_credits
+      end
+
+      model :release_group_secondary_type do
+        has_many :release_group_secondary_type_joins, foreign_key: :secondary_type
+        has_many :release_groups, through: :release_group_secondary_type_joins
+      end
+
+      model :release_group_secondary_type_join do
+        belongs_to :release_group, foreign_key: :release_group
+        belongs_to :type, class_name: 'ReleaseGroupSecondaryType', foreign_key: :secondary_type
+      end
+
+      model :release_group do
+        belongs_to  :release_name, foreign_key: :name
+        has_many    :releases, foreign_key: :release_group
+        has_name    :release_name
+        belongs_to  :type, class_name: 'ReleaseGroupPrimaryType', foreign_key: :type
+        has_many    :release_group_secondary_type_joins, foreign_key: :release_group
+        has_many    :secondary_types, through: :release_group_secondary_type_joins, source: :type
+
+        has_artist_credits
+      end
+
+      model :release do
+        belongs_to  :release_name, foreign_key: :name
+        belongs_to  :release_group, foreign_key: :release_group
+        has_many    :mediums, foreign_key: :release, order: :position
+        has_many    :recordings, through: :mediums
+        has_name    :release_name
+        has_many    :tracks, through: :mediums
+        belongs_to  :status, class_name: 'ReleaseStatus', foreign_key: :status
+        belongs_to  :packaging, class_name: 'ReleasePackaging', foreign_key: :packaging
+
+        has_artist_credits
+      end
+
+      model :medium do
+        belongs_to  :release, foreign_key: :release
+        has_many    :tracks, foreign_key: :medium
+        has_many    :recordings, through: :tracks
+        belongs_to  :format, class_name: 'MediumFormat', foreign_key: :format
+        belongs_to  :medium_format, foreign_key: :format
+      end
+
+      model :recording do
+        belongs_to  :track_name, foreign_key: :name
+        has_many    :tracks, foreign_key: :recording
+        has_many    :release_groups, through: :tracks
+        has_many    :releases, through: :mediums
+        has_many    :release_groups, through: :releases
+        has_many    :mediums, through: :tracks
+        has_name    :track_name
+        has_artist_credits
+      end
+    end
+  end
+end

data/lib/active_musicbrainz/version.rb

@@ -0,0 +1,3 @@
+module ActiveMusicbrainz
+  VERSION = "0.1.0"
+end

data/test/config.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: 'postgresql'
+  database: 'musicbrainz'
+  username: 'musicbrainz'
+

data/test/models/model_test.rb

@@ -0,0 +1,42 @@
+require_relative '../test_helper'
+
+module ActiveMusicbrainz
+  describe Model do
+
+    def model table_name, &block
+      Model::Factory.define.model table_name, &block
+    end
+
+    after do
+      Model.send :remove_const, 'Artist'
+    end
+
+    it 'creates model class' do
+      klass = model 'artist'
+      klass.superclass.must_equal(ActiveRecord::Base)
+    end
+
+    it 'sends &block to the created class' do
+      klass = model 'artist' do
+        def hello; end
+      end
+      klass.instance_methods.must_include :hello
+    end
+
+    it 'creates the new model inside the Model module' do
+     klass = model 'artist'
+     klass.name.must_equal 'ActiveMusicbrainz::Model::Artist'
+    end
+
+    it 'reopens class' do
+      model 'artist' do
+        def method_1; end
+      end
+      model 'artist' do
+        def method_2; end
+      end
+      Model::Artist.instance_methods.must_include :method_1
+      Model::Artist.instance_methods.must_include :method_2
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'minitest/autorun'
+require 'rubygems'
+require 'active_musicbrainz'
+require 'yaml'
+
+config = YAML.load_file(File.join(File.dirname(__FILE__), 'config.yml'))
+
+
+ActiveRecord::Base.establish_connection config['test']
+ActiveMusicbrainz.init
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: active_musicbrainz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrea Franz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord models for the MusicBrainz database.
+email:
+- andrea@gravityblast.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_musicbrainz.gemspec
+- lib/active_musicbrainz.rb
+- lib/active_musicbrainz/config.rb
+- lib/active_musicbrainz/models/base.rb
+- lib/active_musicbrainz/models/factory.rb
+- lib/active_musicbrainz/models/model.rb
+- lib/active_musicbrainz/version.rb
+- test/config.yml
+- test/models/model_test.rb
+- test/test_helper.rb
+homepage: https://github.com/pilu/active_musicbrainz
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: ActiveRecord models the MusicBrainz database
+test_files:
+- test/config.yml
+- test/models/model_test.rb
+- test/test_helper.rb