organizer-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e91878913dc46de82d051515ae95701982e56898dd29b2f7904027f141b4e95
+  data.tar.gz: 3be44a3b6e77c8874902553273cf1a84dff0569c2587b5deaae24cab66ede6bc
+SHA512:
+  metadata.gz: 7dfa7797f8eff39028f58681463bec5dc5f65ba52958f8b54e63111a3bde4d94dbfef8660957433fd9ba7d36e06e344dc343dbe164f70f3e3ac7fb12cc2f9076
+  data.tar.gz: b2af4b380c145031992e9a452e1ad79338488af4a5008760a4804043b545aa07db407d05dc3940fc3847dba7441d404cbdee49d6a07b6f47a8b24bed6162a522

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Alexander Senko
+
+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,46 @@
+# Organizer
+
+A Rails Engine providing some tools to organize your application records, e.g. _lists_, _tags_, _flags_, etc.
+
+## Usage
+
+### `Identifiable`
+
+Presuming `MyModel` has a unique `name` attribute:
+
+```ruby
+class MyModel < ApplicationRecord
+  include Organizer::Identifiable.by :name
+end
+
+MyModel.names     # => [:my_name, :other_name, …]
+MyModel[:my_name] # => #<MyModel1 id: 1, name: "my_name">
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "organizer-rails"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install organizer-rails
+```
+
+## 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
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/organizer_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/organizer .css

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

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/lists_controller.rb

@@ -0,0 +1,2 @@
+class ListsController < InheritedResources::Base
+end

data/app/controllers/organizer/application_controller.rb

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

data/app/decorators/list_decorator.rb

@@ -0,0 +1,5 @@
+class ListDecorator < ApplicationDecorator
+	delegate_all
+
+	decorates_association :messages
+end

data/app/helpers/organizer/application_helper.rb

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

data/app/jobs/organizer/application_job.rb

@@ -0,0 +1,4 @@
+module Organizer
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/organizer/application_mailer.rb

@@ -0,0 +1,6 @@
+module Organizer
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/concerns/organizer/identifiable.rb

@@ -0,0 +1,46 @@
+module Organizer
+	concern :Identifiable do
+		class << self
+			def by column_name
+				dup.tap do
+					_1.module_eval do
+						included do
+							@identified_by = column_name
+						end
+
+						class_methods do # public API
+							define_method(column_name.to_s.pluralize) { identifiers }
+						end
+					end
+				end
+			end
+		end
+
+		class_methods do
+			def [] *id
+				return id.map { self[_1] } if id.many?
+
+				case id = id.first
+				when Enumerable
+					id.filter_map { identified_as _1 }
+				else
+					identified_as id or
+							raise ArgumentError, "Couldn't find #{self} `#{id}`"
+				end
+			end
+
+			private
+
+			def identifiers
+				@identifiers ||= # cache
+						all.pluck(@identified_by)
+								.map &:to_sym
+			end
+
+			def identified_as identifier
+				(@identified ||= {}.with_indifferent_access)[identifier] ||= # cache
+						find_by @identified_by => identifier
+			end
+		end
+	end
+end

data/app/models/organizer/application_record.rb

@@ -0,0 +1,5 @@
+module Organizer
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Organizer</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "organizer/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Organizer::Engine.routes.draw do
+end

data/lib/organizer/authors.rb

@@ -0,0 +1,15 @@
+Gem::Author ||= Struct.new(
+		:name,
+		:email,
+		:github_url,
+)
+
+module Organizer
+	AUTHORS = [
+			Gem::Author.new(
+					name:       'Alexander Senko',
+					email:      'Alexander.Senko@gmail.com',
+					github_url: 'https://github.com/Alexander-Senko',
+			),
+	]
+end

data/lib/organizer/engine.rb

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

data/lib/organizer/version.rb

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

data/lib/organizer.rb

@@ -0,0 +1,6 @@
+require "organizer/version"
+require "organizer/engine"
+
+module Organizer
+  # Your code goes here...
+end

data/lib/tasks/organizer_tasks.rake

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: organizer-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Senko
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: Use lists, tags, flags, etc. to organize your application records.
+email:
+- Alexander.Senko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/organizer_manifest.js
+- app/assets/stylesheets/organizer/application.css
+- app/controllers/lists_controller.rb
+- app/controllers/organizer/application_controller.rb
+- app/decorators/list_decorator.rb
+- app/helpers/organizer/application_helper.rb
+- app/jobs/organizer/application_job.rb
+- app/mailers/organizer/application_mailer.rb
+- app/models/concerns/organizer/identifiable.rb
+- app/models/organizer/application_record.rb
+- app/views/layouts/organizer/application.html.erb
+- config/routes.rb
+- lib/organizer.rb
+- lib/organizer/authors.rb
+- lib/organizer/engine.rb
+- lib/organizer/version.rb
+- lib/tasks/organizer_tasks.rake
+homepage: https://github.com/Alexander-Senko/organizer-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Alexander-Senko/organizer-rails
+  source_code_uri: https://github.com/Alexander-Senko/organizer-rails
+  changelog_uri: https://github.com/Alexander-Senko/organizer-rails/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.0.dev
+signing_key:
+specification_version: 4
+summary: Record organizer for Rails
+test_files: []