active_brainz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de315d1362f515a08a4b332ca37cb680c1f7cc0b56631d267ca6d01dba86f064
+  data.tar.gz: 1b10dab84039dc27fc85e3180f1d31c280ff961bca4055600bbafa67cc929cde
+SHA512:
+  metadata.gz: b81268c56a7c2ffa2f527c6c66d7bf766c7d1d39058df455d7116b667788bc40e244b9cef702564abbc627090b667c78f4f40d3288fbc22f5c9069b03b728174
+  data.tar.gz: 59378fea9c9b97441c95cdddd8d55e724cb011ec4b39de09801de7207eeadb22aa5de94c818e658a82c9dc3502de8d8da96e49a3bceb95b180e890fad15a06fc

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_brainz.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Florian Dejonckheere
+
+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,83 @@
+# ActiveBrainz
+
+![Continuous Integration](https://github.com/floriandejonckheere/active_brainz/workflows/Continuous%20Integration/badge.svg)
+![Release](https://img.shields.io/github/v/release/floriandejonckheere/active_brainz?label=Latest%20release)
+
+ActiveRecord integrations for the [MusicBrainz database](https://musicbrainz.org/doc/MusicBrainz_Database).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "active_brainz"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_brainz
+
+## Configuration
+
+Configure your `database.yml` with the MusicBrainz database:
+
+```yaml
+musicbrainz:
+  adapter: postgresql
+  host: postgres
+  port: 5432
+  database: musicbrainz
+  user: musicbrainz
+  password: musicbrainz
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Documentation
+
+The SQL scripts used to create the MusicBrainz database schema can be found on their [Github repository](https://github.com/metabrainz/musicbrainz-server/tree/master/admin/sql).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+Then, run `rake spec` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Modify `config/database.rb` or use environment variables to connect to a non-localhost server.
+
+The following rake tasks are available:
+
+```
+rake active_brainz:models:annotate  # Annotate models
+rake active_brainz:models:generate  # Generates models based on db/schema.rb file
+rake active_brainz:models:render    # Generate and annotate models
+rake db:create                      # Creates the database
+rake db:drop                        # Drops the database
+rake db:schema:dump                 # Dumps the database structure to db/schema.rb
+rake db:schema:load                 # Recreates the databases from the schema.rb file
+rake spec                           # Run RSpec code examples
+
+```
+
+To release a new version, update the version number in `lib/active_brainz/version.rb`, commit it and create a git tag starting with `v`, and push it to the repository.
+Github Actions will automatically run the test suite, build the `.gem` file and push it to [rubygems.org](https://rubygems.org).
+
+If MusicBrainz' database schema version gets bumped, don't forget to bump the schema version in `lib/active_brainz/version.rb` as well.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/floriandejonckheere/active_brainz](https://github.com/floriandejonckheere/active_brainz). 
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/floriandejonckheere/active_brainz/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveBrainz project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/floriandejonckheere/active_brainz/blob/master/CODE_OF_CONDUCT.md).

data/config/inflections.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+ActiveBrainz.loader.inflector = ActiveSupport::Inflector
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.acronym "GID"
+  inflect.acronym "IPI"
+  inflect.acronym "ISNI"
+end

data/lib/active_brainz.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "byebug" if ENV["ACTIVE_BRAINZ_ENV"] == "development"
+require "active_support/all"
+
+module ActiveBrainz
+  class << self
+    # Code loader instance
+    attr_reader :loader
+
+    def root
+      @root ||= Pathname.new(File.expand_path(File.join("..", ".."), __FILE__))
+    end
+
+    def setup
+      @loader = Zeitwerk::Loader.for_gem
+
+      # Register inflections
+      require root.join("config/inflections.rb")
+
+      # Set up code loader
+      loader.enable_reloading if ENV["ACTIVE_BRAINZ_ENV"] == "development"
+      loader.collapse("lib/active_brainz/models")
+      loader.collapse("lib/active_brainz/models/*")
+
+      loader.setup
+      loader.eager_load
+
+      # Load initializers
+      Dir[root.join("config/initializers/*.rb")].sort.each { |f| require f }
+    end
+  end
+end
+
+ActiveBrainz.setup

data/lib/active_brainz/models/area/area.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module ActiveBrainz
+  class Area < Base
+    self.table_name = "area"
+
+    include HasGID
+    include HasBeginEndDate
+
+    belongs_to :area_type,
+               class_name: "AreaType",
+               foreign_key: "type",
+               optional: true
+
+    # has_many :area_aliases,
+    #          class_name: "AreaAlias",
+    #          foreign_key: "area"
+
+    # has_many :area_annotations,
+    #          class_name: "AreaAnnotation",
+    #          foreign_key: "area"
+
+    # has_many :area_attributes,
+    #          class_name: "AreaAttribute",
+    #          foreign_key: "area"
+
+    # has_many :area_tag_raws,
+    #          class_name: "AreaTagRaw",
+    #          foreign_key: "area"
+
+    # has_many :area_tags,
+    #          class_name: "AreaTag",
+    #          foreign_key: "area"
+
+    has_many :area_artists,
+             class_name: "Artist",
+             foreign_key: "area"
+
+    has_many :begin_area_artists,
+             class_name: "Artist",
+             foreign_key: "begin_area"
+
+    has_many :end_area_artists,
+             class_name: "Artist",
+             foreign_key: "end_area"
+
+    # has_many :area_country_areas,
+    #          class_name: "CountryArea",
+    #          foreign_key: "area"
+
+    # has_many :area_edit_areas,
+    #          class_name: "EditArea",
+    #          foreign_key: "area"
+
+    # has_many :area_editor_collection_areas,
+    #          class_name: "EditorCollectionArea",
+    #          foreign_key: "area"
+
+    # has_many :area_editors,
+    #          class_name: "Editor",
+    #          foreign_key: "area"
+
+    # has_many :area_iso_3166_1s,
+    #          class_name: "Iso31661",
+    #          foreign_key: "area"
+
+    # has_many :area_iso_3166_2s,
+    #          class_name: "Iso31662",
+    #          foreign_key: "area"
+
+    # has_many :area_iso_3166_3s,
+    #          class_name: "Iso31663",
+    #          foreign_key: "area"
+
+    has_many :area_labels,
+             class_name: "Label",
+             foreign_key: "area"
+
+    # has_many :area_new_ids,
+    #          class_name: "AreaGIDRedirect",
+    #          foreign_key: "new_id"
+
+    # has_many :area_places,
+    #          class_name: "Place",
+    #          foreign_key: "area"
+
+    attribute :name
+    attribute :comment
+
+    attribute :edits_pending, :integer
+    attribute :last_updated, :datetime
+  end
+end
+
+# == Schema Information
+#
+# Table name: area
+#
+#  id               :integer          not null, primary key
+#  begin_date_day   :integer
+#  begin_date_month :integer
+#  begin_date_year  :integer
+#  comment          :string(255)      default(""), not null
+#  edits_pending    :integer          default(0), not null
+#  end_date_day     :integer
+#  end_date_month   :integer
+#  end_date_year    :integer
+#  ended            :boolean          default(FALSE), not null
+#  gid              :uuid             not null
+#  last_updated     :datetime
+#  name             :string           not null
+#  type             :integer
+#
+# Indexes
+#
+#  area_idx_gid       (gid) UNIQUE
+#  area_idx_name      (name)
+#  area_idx_name_txt  (mb_simple_tsvector((name)::text)) USING gin
+#
+# Foreign Keys
+#
+#  area_fk_type  (type => area_type.id)
+#

data/lib/active_brainz/models/area/area_type.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ActiveBrainz
+  class AreaType < Base
+    self.table_name = "area_type"
+
+    include HasGID
+    include HasParentChildren
+
+    has_many :areas,
+             class_name: "Area",
+             foreign_key: "type"
+
+    attribute :name
+    attribute :description
+  end
+end
+
+# == Schema Information
+#
+# Table name: area_type
+#
+#  id          :integer          not null, primary key
+#  child_order :integer          default(0), not null
+#  description :text
+#  gid         :uuid             not null
+#  name        :string(255)      not null
+#  parent      :integer
+#
+# Indexes
+#
+#  area_type_idx_gid  (gid) UNIQUE
+#
+# Foreign Keys
+#
+#  area_type_fk_parent  (parent => area_type.id)
+#

data/lib/active_brainz/models/artist/artist.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module ActiveBrainz
+  class Artist < Base
+    self.table_name = "artist"
+
+    include HasGID
+    include HasBeginEndDate
+
+    belongs_to :artist_area,
+               class_name: "Area",
+               foreign_key: "area",
+               optional: true
+
+    belongs_to :artist_type,
+               class_name: "ArtistType",
+               foreign_key: "type",
+               optional: true
+
+    belongs_to :artist_begin_area,
+               class_name: "Area",
+               foreign_key: "begin_area",
+               optional: true
+
+    belongs_to :artist_end_area,
+               class_name: "Area",
+               foreign_key: "end_area",
+               optional: true
+
+    belongs_to :artist_gender,
+               class_name: "Gender",
+               foreign_key: "gender",
+               optional: true
+
+    has_many :artist_aliases,
+             class_name: "ArtistAlias",
+             foreign_key: "artist"
+
+    # has_many :artist_annotations,
+    #          class_name: "ArtistAnnotation",
+    #          foreign_key: "artist"
+
+    # has_many :artist_attributes,
+    #          class_name: "ArtistAttribute",
+    #          foreign_key: "artist"
+
+    has_many :artist_credit_names,
+             class_name: "ArtistCreditName",
+             foreign_key: "artist"
+
+    # has_many :artist_ipis,
+    #          class_name: "ArtistIPI",
+    #          foreign_key: "artist"
+
+    # has_many :artist_isnis,
+    #          class_name: "ArtistISNI",
+    #          foreign_key: "artist"
+
+    # has_many :artist_meta,
+    #          class_name: "ArtistMeta",
+    #          foreign_key: "id"
+
+    # has_many :artist_rating_raws,
+    #          class_name: "ArtistRatingRaw",
+    #          foreign_key: "artist"
+
+    # has_many :artist_tag_raws,
+    #          class_name: "ArtistTagRaw",
+    #          foreign_key: "artist"
+
+    # has_many :artist_tags,
+    #          class_name: "ArtistTag",
+    #          foreign_key: "artist"
+
+    # has_many :artist_edit_artists,
+    #          class_name: "EditArtist",
+    #          foreign_key: "artist"
+
+    # has_many :artist_editor_collection_artists,
+    #          class_name: "EditorCollectionArtist",
+    #          foreign_key: "artist"
+
+    # has_many :artist_editor_subscribe_artists,
+    #          class_name: "EditorSubscribeArtist",
+    #          foreign_key: "artist"
+
+    # has_many :artist_editor_watch_artists,
+    #          class_name: "EditorWatchArtist",
+    #          foreign_key: "artist"
+
+    # has_many :artist_new_ids,
+    #          class_name: "ArtistGIDRedirect",
+    #          foreign_key: "new_id"
+
+    attribute :name
+    attribute :sort_name
+
+    attribute :comment
+    attribute :edits_pending, :integer
+    attribute :last_updated, :datetime
+  end
+end
+
+# == Schema Information
+#
+# Table name: artist
+#
+#  id               :integer          not null, primary key
+#  area             :integer
+#  begin_area       :integer
+#  begin_date_day   :integer
+#  begin_date_month :integer
+#  begin_date_year  :integer
+#  comment          :string(255)      default(""), not null
+#  edits_pending    :integer          default(0), not null
+#  end_area         :integer
+#  end_date_day     :integer
+#  end_date_month   :integer
+#  end_date_year    :integer
+#  ended            :boolean          default(FALSE), not null
+#  gender           :integer
+#  gid              :uuid             not null
+#  last_updated     :datetime
+#  name             :string           not null
+#  sort_name        :string           not null
+#  type             :integer
+#
+# Indexes
+#
+#  artist_idx_area                 (area)
+#  artist_idx_begin_area           (begin_area)
+#  artist_idx_end_area             (end_area)
+#  artist_idx_gid                  (gid) UNIQUE
+#  artist_idx_lower_name           (lower((name)::text))
+#  artist_idx_musicbrainz_collate  (name)
+#  artist_idx_name                 (name)
+#  artist_idx_null_comment         (name) UNIQUE WHERE (comment IS NULL)
+#  artist_idx_sort_name            (sort_name)
+#  artist_idx_txt                  (mb_simple_tsvector((name)::text)) USING gin
+#  artist_idx_txt_sort             (mb_simple_tsvector((sort_name)::text)) USING gin
+#  artist_idx_uniq_name_comment    (name,comment) UNIQUE WHERE (comment IS NOT NULL)
+#
+# Foreign Keys
+#
+#  artist_fk_area        (area => area.id)
+#  artist_fk_begin_area  (begin_area => area.id)
+#  artist_fk_end_area    (end_area => area.id)
+#  artist_fk_gender      (gender => gender.id)
+#  artist_fk_type        (type => artist_type.id)
+#