simplec 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f95b9fb5eef66eaf27ab18d642ee76f5ea67a547
-  data.tar.gz: 05505f307bf86ffd6afd16545f5b6a5396a708da
+  metadata.gz: cc12728b3f36924c9748feeaf9b913adf6f2f4c5
+  data.tar.gz: acf72f1d1f5116208a044018df7e50ca298f458e
 SHA512:
-  metadata.gz: c4cadd40978e45f0f20c8759226bef7ba6d6c2564de022ba589bfd36cf6af9a0520c40979b90c8aa9c764eb68113eaa7353e6da576a4f01bb70d7f291895325e
-  data.tar.gz: 88d5a6034a54698c229887b0ab8165b5c6a0ef9fe309440a63895089cd53726cad136f8015173d597217154fab58d243a9f2b88dea95d35d62e9919dbe113156
+  metadata.gz: d7bd9cd9bc1007492113fc583e5c3eca2023938f6ab50f326e2f2ea194c946d24ec6bc5fe06aee34c88722f13ba8da53751282c8e233fb9e8fa21ea0ed190634
+  data.tar.gz: 0fb75e9fa2898854726b89dca64b5c3c610059835c5eecbf2dad81c53fd6aa3cd1a7f8e9071536b7edf59f8aa805ed57eec1644ec75d79bfde4833ab85a35b7f

data/README.md

@@ -18,7 +18,8 @@ over the entire ecosystem.
 
 - imagemagick
 
-    For image processing.
+    For image processing. Note there is a known vulnerability, please update
+    accordingly: https://imagetragick.com/
 
 - dragonfly
 
@@ -76,12 +77,6 @@ fallout. ;-)_
 
 ## Usage
 
-1. Add to gemfile
-2. Mount engine
-3. Create pages and corresponding templates
-4. Build, generator, or use an auxilary gem for page admin.
-5. Let users loose.
-
 'www' is considered the default subdomain.
 
 'admin' subdomain is reserved for administration functions if you wish.
@@ -103,6 +98,8 @@ TODO override field types howto
 
 TODO explain using uuids for keys + pgcrypto
 
+TODO explain how to augment model classes (example in `test/dummy/config/initializers/simplec.rb`)
+
 ### Steps
 
 1. Install simplec in your Rails application.
@@ -245,7 +242,25 @@ See this page for a good cheat sheet: http://markevans.github.io/dragonfly/image
 
 ## Roadmap
 
-1. Finish example admin.
+1. TODOS:
+
+    - Embedded image id (integer -> uuid)
+
+    - Check doc view helpers
+
+    - Throw clear warning when creating a page without a type
+
+    - Document `lib/simplec/controller_extensions.rb`
+
+    - Document why _subdomain in subdomain form in admin.
+
+    - rails generate simplec:install
+      Install app/models/page.rb, app/models/page/
+      initializer if needed, with options documented
+
+    - rewrite beginning part of usage
+
+    - simplec_path/simplec_url caching
 
 1. Installer `rails generater simplec:install`
 
@@ -264,18 +279,6 @@ See this page for a good cheat sheet: http://markevans.github.io/dragonfly/image
   relegated to 3rd party extensions.
 2. Pull requests are welcome. See rule #1.
 
-## TODO
-
-- Document `lib/simplec/controller_extensions.rb`
-
-- Document why _subdomain in subdomain form in admin.
-
-- rails generate simplec:install
-  Install app/models/page.rb, app/models/page/
-  initializer if needed, with options documented
-
-- simplec_path/simplec_url caching
-
 ## Running dummy application
 
 1. Create simplec postgres user

data/app/models/simplec/document.rb

@@ -0,0 +1,37 @@
+module Simplec
+  class Document < ApplicationRecord
+
+    belongs_to :document_set,
+      optional: true
+    has_and_belongs_to_many :subdomains
+
+    dragonfly_accessor :file
+
+    validates :name,
+      presence: true
+    validate :validate_subdomain_or_set!
+    validate :validate_slug!
+
+    def path
+      self.file.url
+    end
+
+    private
+
+    def validate_subdomain_or_set!
+      return if self.subdomains.length > 0
+      return if self.document_set
+      errors.add :subdomain_ids, 'either a document set or at least one subdomain is required'
+    end
+
+    def validate_slug!
+      similar = self.class.where(slug: self.slug).where.not(id: self.id)
+      return if similar.size == 0
+      return if (
+        similar.map(&:subdomain_ids).flatten & self.subdomain_ids
+      ).length == 0
+      errors.add :slug, 'slug must be unique across linked subdomains'
+    end
+
+  end
+end

data/app/models/simplec/document_set.rb

@@ -0,0 +1,29 @@
+module Simplec
+  class DocumentSet < ApplicationRecord
+
+    has_many :documents
+    has_and_belongs_to_many :subdomains
+
+    validates :name,
+      presence: true
+    validate :validate_subdomain!
+    validate :validate_slug!
+
+    private
+
+    def validate_subdomain!
+      return if self.subdomains.length > 0
+      errors.add :subdomain_ids, 'at least one is required'
+    end
+
+    def validate_slug!
+      similar = self.class.where(slug: self.slug).where.not(id: self.id)
+      return if similar.size == 0
+      return if (
+        similar.map(&:subdomain_ids).flatten & self.subdomain_ids
+      ).length == 0
+      errors.add :slug, 'slug must be unique across linked subdomains'
+    end
+
+  end
+end

data/db/migrate/20170814211816_create_simplec_documents.rb

@@ -0,0 +1,26 @@
+class CreateSimplecDocuments < ActiveRecord::Migration[5.1]
+  def change
+    create_table :simplec_documents, id: :uuid, default: 'gen_random_uuid()' do |t|
+      t.uuid :document_set_id
+      t.string :slug
+      t.string :name
+      t.boolean :required, default: false
+      t.text :description
+      t.string :file_uid
+      t.string :file_name
+
+      t.timestamps
+    end
+		add_index :simplec_documents, :document_set_id
+    add_index :simplec_documents, :slug
+    add_index :simplec_documents, :name
+
+    create_table :simplec_documents_subdomains, index: false do |t|
+      t.uuid :document_id
+      t.uuid :subdomain_id
+    end
+    add_index :simplec_documents_subdomains, [:document_id, :subdomain_id],
+      unique: true,
+      name: 'index_simplec_documents_subdomains_unique'
+  end
+end

data/db/migrate/20170814211929_create_simplec_document_sets.rb

@@ -0,0 +1,22 @@
+class CreateSimplecDocumentSets < ActiveRecord::Migration[5.1]
+  def change
+    create_table :simplec_document_sets, id: :uuid, default: 'gen_random_uuid()' do |t|
+      t.string :slug
+      t.string :name
+      t.boolean :required, default: false
+      t.text :description
+
+      t.timestamps
+    end
+    add_index :simplec_document_sets, :slug
+    add_index :simplec_document_sets, :name
+
+    create_table :simplec_document_sets_subdomains, index: false do |t|
+      t.uuid :document_set_id
+      t.uuid :subdomain_id
+    end
+    add_index :simplec_document_sets_subdomains, [:document_set_id, :subdomain_id],
+      unique: true,
+      name: 'index_simplec_document_sets_subdomains_unique'
+  end
+end

data/lib/simplec/version.rb

@@ -1,3 +1,3 @@
 module Simplec
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplec
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -120,6 +120,8 @@ files:
 - app/jobs/simplec/application_job.rb
 - app/mailers/simplec/application_mailer.rb
 - app/models/simplec/application_record.rb
+- app/models/simplec/document.rb
+- app/models/simplec/document_set.rb
 - app/models/simplec/embedded_image.rb
 - app/models/simplec/page.rb
 - app/models/simplec/subdomain.rb
@@ -133,6 +135,8 @@ files:
 - db/migrate/20170809204353_create_simplec_pages.rb
 - db/migrate/20170809204511_create_simplec_subdomains.rb
 - db/migrate/20170809210304_create_simplec_embedded_images.rb
+- db/migrate/20170814211816_create_simplec_documents.rb
+- db/migrate/20170814211929_create_simplec_document_sets.rb
 - lib/simplec.rb
 - lib/simplec/action_controller/extensions.rb
 - lib/simplec/action_view/helper.rb