card 1.91 → 1.92

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 793969983b8a29c082968711d896a47c63c0afee
-  data.tar.gz: a98e52b0d1cf0fbe1355d4a6cfaf4363b4d3bb77
+  metadata.gz: 47455178df73a19b8c9a200fb6ffc996f5303489
+  data.tar.gz: fb7046e99420ee3cc2af2dc47723a1d3ad17ad73
 SHA512:
-  metadata.gz: 6b8c9196a25ec3f59c03fb49a506fdb3dc5a8fab5ffe0255a69edcc16e66cfc05e5821492c7ed77c0fba1b16029f676f8ef3440c8d45cbe65a825fb8f64eb165
-  data.tar.gz: 1595c2661ec75abb25b84df2b865cea44f23a7f6d4db64bb4d1906ff942355484c85b52b94c41795ec4f31b595a25546e7f0b1ee97d84e52d8ade696afe5083a
+  metadata.gz: 8d6a3bdc814d7f8ca80b0a5c08f0e0b6f9cff85ebd35737c09104bc3a6c5b35779b71ed982d692f05a2d1955ea6d5cd355fba17a12915f878ffbb55f68377451
+  data.tar.gz: 7d962a151eeebaa50d17df1b7e25883209a62744395669190f78ac02afc627cca3da72646d7f53b63f7b13785fa81279d7de1edafc44e4119c0b4ecb52aa0847

data/README.rdoc

@@ -0,0 +1,80 @@
+
+=A Developer's introduction to the Decko/Card code base
+
+New folks should start here after playing with Decko but before digging into code.
+
+==Intro
+
+===Am I in the right place?
+
+Yes, if:
+
+* <b>you're a Ruby developer</b>, or at least someone who does not fear ruby code. <b>Not a techie? {Try Decko.org}[http://decko.org]</b>
+* <b>you've experimented with Decko</b> enough to know the basics (cards, types, rules, etc.) <b>No idea what a card is? {Try Decko.org}[http://decko.org]</b>.
+* <b>you're looking at this page from a docs site</b> (ie, NOT GitHub) so you can use our links to navigate code. <b>Links look funny? {Try rubydocs.info}[http://rubydoc.info/gems/card].</b>
+
+
+===Decko: an _application_ or a <i>development framework</i>?
+
+It's both.
+
+When you install and seed a new Decko project, you have a working "deck" right away. Your new application has a lot built in: account handling, edit histories, default layouts, CSS, etc. But a new deck is just a starting point. Decko offers a rich framework within which to develop your own novel applications, both <b>via configuration (as a "Decker")</b> or <b>via code (as a "Deck-coder")</b>.
+
+<b>Decko is a development framework in which you start <i>in the middle of things</i> rather than from scratch</b>. Decko gives you a headstart, so that designers, developers, and content creators can start working in parallel on day one. But from there, you can build (or remove) pretty much whatever you want.
+
+
+===Decko: Ruby on Rails?
+
+Ruby-on-Rails developers reading this will find lots of familiar patterns in Decko, which indeed depends upon rails gems. <b>Although Decko is a Rails descendant and owes a ton to the Rails community, it is not Rails.</b> Unlike Rails, Decko is not an implementation of the "MVC" (Model-View-Controller) architectural pattern (see Architecture below). More concretely, while Rails' core pattern is adding new things (especially models, views, and controllers), Decko's core pattern is subdividing exising things into new Sets.
+
+Deck-coders do create lots of card views (though they're quite different from Rails views), but we rarely if ever create new controllers or ActiveRecord models. In the Decko gem there is one controller (CardController) and one main model ({Card}). Other models optimize the Card model and track its history: (See {Card::Reference references}, {Card::Act acts}, {Card::Action actions}, and {Card::Change changes}).
+
+
+===Cards, Sets, and Rules
+
+{Card _Cards_} are the basic building blocks of Decko. {Card::Set _Sets_} are the basic pattern for organizing cards. <b>Both Deckers and Deck-coders create web systems by applying _rules_ to _sets_ of _cards_.</b>
+
+If you've edited card rules in any deck, you will have encountered Sets. For example, imagine you're on a User card named "Henry", and you decide to edit its structure. When you do, you'll be prompted to choose the Set of cards to which the structure rule applies, eg:
+
+* Just "Henry"
+* All Users
+* All Cards
+
+The Rule in question will apply to all cards in the set you choose. If a card has rules in more than one set, the rule applied to the narrower set overrides the rule applied to the broader one.
+
+This same general pattern occurs in Decko code: code rules (methods) are organized under the Set of cards to which they apply. This means both code rules and card (data) rules) can be as narrow or specific as desired.
+
+
+==Architecture
+
+Sets are central to Decko's architecture, which follows a new pattern that we call _MoFoS_. MoFoS stands for "Model-Formats-Sets": One <b>Mo</b>del, viewable in many {Card::Format <b>Fo</b>rmats}, divisible into {Card::Set <b>S</b>ets}.
+
+In Decko, the MoFoS "model" is, as you may have guessed, the {Card _Card_}. We've just explore {Card::Set _Sets_} above.  But what are {Card::Format Formats}?
+
+You may have noticed that you can add .html (the default), .text, .json, etc to any card's web path to receive the card's contents in a different file format. These are achieved by {Card::Format Format} classes. HTML, Json, Text, etc each has its own Format class.
+
+In keeping with this architecture, Decko's code is heavily organized around correlating Ruby classes for the model and formats:
+
+1. the "model" is {Card}
+2. the "formats" are {Card::Format} and its descendants
+
+Sets are implemented not as Ruby classes but as Ruby modules that are included in applicable card and format objects. For example, when fetching the "Henry" card, the Card object's singleton class will include the module Card::Set::Type::User.  And when rendering a view of that card in Html, the format object will include Card::Set::Type::User::HtmlFormat. That's a mouthful. It's also something you'll never have to write (or think about really), because Set functionality is almost always developed using our Set DSL, which automatically handles the ruby module naming based on the file name.
+
+Cards, Formats, Sets, and other structures can all be developed via {Card::Mod Mods}.
+
+==Mods
+
+{Card::Mod Card Mods} (short for _modules_ or _modifications_) are the primary mechanism for developing and sharing Decko code. If you're just getting started as a Decko developer, learning about {Card::Mod Mods} is a great next step.
+
+
+
+
+
+
+
+
+
+
+
+
+

data/VERSION

@@ -1 +1 @@
-0.1
+0.2

data/card.gemspec

@@ -1,10 +1,10 @@
 # -*- encoding : utf-8 -*-
 
-vraw = File.open(File.expand_path("../VERSION", __FILE__)).read.chomp
-vbits = vraw.split('.').map &:to_i
+version = File.open(File.expand_path("../VERSION", __FILE__)).read.chomp
+vbits = version.split('.').map &:to_i
 vplus = { 0 => 90, 1 => 100 } # can remove and hardcode after 1.0
 vminor = vplus[ vbits[0] ] + vbits[1]
-version = [1, vminor, vbits[2]].compact.map(&:to_s).join "."
+card_version = [1, vminor, vbits[2]].compact.map(&:to_s).join "."
 # Because card was already at 1.21 when wagn was renamed to decko and decko's
 # versioning went back to 0.X, card's versioning is now a little funny.
 # For now decko 0.X.Y will map to card 1.(90+X).Y, and decko 1.X.Y will map to
@@ -13,10 +13,10 @@ version = [1, vminor, vbits[2]].compact.map(&:to_s).join "."
 
 Gem::Specification.new do |s|
   s.name = "card"
-  s.version = version
+  s.version = card_version
 
   s.authors =
-    ["Ethan McCutchen", "Lewis Hoffman", "Gerry Gleason", "Philipp Kühl"]
+    [ "Ethan McCutchen", "Philipp Kühl", "Lewis Hoffman", "Gerry Gleason" ]
   s.email = ["info@decko.org"]
 
   s.summary       = "a simple engine for emergent data structures"
@@ -45,30 +45,37 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = ">= 2.0"
+  s.required_ruby_version = ">= 2.2.2"
 
   [
-    ["smartname",                  "0.5.1"],
-    ["uuid",                       "~> 2.3"],
-    ["carrierwave",                "1.1.0"],
-    ["htmlentities",               "~> 4.3"],
+    ["cardname",                   version],
+    ["haml",                       "~> 5.0"], # markup language used in view API
+    ["uuid",                       "~> 2.3"], # universally unique identifier.
+                                              # used in temporary names
+    ["colorize",                   "~> 0.8"], # livelier cli outputs
+    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    # MOVE TO MODS?
+
+    # files and images
+    ["carrierwave",                "~> 1.1"],
     ["mini_magick",                "~> 4.2"],
-    # recaptcha 0.4.0 is last version that doesn't require ruby 2.0
-    ["recaptcha",                  "~> 0.4.0"],
+
+    # assets (JavaScript, CSS, etc)
     ["coderay",                    "~> 1.1"],
     ["sass",                       "~> 3.4"],
     ["coffee-script",              "~> 2.4"],
     ["uglifier",                   "~> 3.2"],
-    ["nokogiri",                   "1.6.8"], # 1.7 needs ruby 2.1
-    ["haml",                       "~> 5.0"],
-    ["kaminari",                   "~> 0.16"], # 1.0 needs rails 5
-    ["bootstrap-kaminari-views",   "~> 0"],
-    ["diff-lcs",                   "~> 1.3"],
-    # mime-types can be removed if we drop support for ruby 1.9.3
-    # mime-types 3.0 uses mime-types-data which isn't compatible with 1.9.3
-    ["mime-types",                 "2.99.1"],
-    ["twitter",                    "6.1.0"],
-    ["colorize",                   "0.8"]
+
+    # pagination
+    ["kaminari",                   "~> 1.0"],
+    ["bootstrap4-kaminari-views",  "~> 1.0"],
+
+    # other
+    ["diff-lcs",                   "~> 1.3"], # content diffs in histories
+    ["recaptcha",                  "~> 4.3"],
+    ["twitter",                    "~> 6.1"]  # for event-based integration
+
+
   ].each do |dep|
     s.add_runtime_dependency(*dep)
   end

data/config/i18n-tasks.yml

@@ -56,7 +56,8 @@ search:
     - mod/
 
   ## Root directories for relative keys resolution.
-  # relative_roots:
+  relative_roots:
+    - .
   #   - app/controllers
   #   - app/helpers
   #   - app/mailers
@@ -124,3 +125,9 @@ ignore_unused:
 #
 # <%#= I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
 #        patterns: [['\bSpree\.t[( ]\s*%{key}', 'spree.%{key}']] %>
+# <%#= I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#       patterns: [['\btee[( ]%{key}', '#{path}.%{key}']] %>
+
+#<%#= I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#       patterns: [['\baccount_link_text[( ]\s*%{key}', 'mod.account.set.self.account_links.%{key}']] %>
+<% require './lib/card/set/i18n_scanner' %>

data/config/initializers/01_core_extensions/module.rb

@@ -1,10 +1,7 @@
 module CoreExtensions
   module Module
-    RUBY_VERSION_18 = !!(RUBY_VERSION =~ /^1\.8/)
-
     def const_get_if_defined const
-      args = RUBY_VERSION_18 ? [const] : [const, false]
-      const_get(*args) if const_defined?(*args)
+      const_get(const, false) if const_defined?(const, false)
     end
 
     def const_remove_if_defined const
@@ -23,5 +20,50 @@ module CoreExtensions
         end
       end
     end
+
+    # Encapsulates the common pattern of:
+    #
+    #   alias_method :foo_without_feature, :foo
+    #   alias_method :foo, :foo_with_feature
+    #
+    # With this, you simply do:
+    #
+    #   alias_method_chain :foo, :feature
+    #
+    # And both aliases are set up for you.
+    #
+    # Query and bang methods (foo?, foo!) keep the same punctuation:
+    #
+    #   alias_method_chain :foo?, :feature
+    #
+    # is equivalent to
+    #
+    #   alias_method :foo_without_feature?, :foo?
+    #   alias_method :foo?, :foo_with_feature?
+    #
+    # so you can safely chain foo, foo?, foo! and/or foo= with the same feature.
+    #
+    # has been removed in rails 5
+    def alias_method_chain(target, feature)
+      # Strip out punctuation on predicates, bang or writer methods since
+      # e.g. target?_without_feature is not a valid method name.
+      aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+      yield(aliased_target, punctuation) if block_given?
+
+      with_method = "#{aliased_target}_with_#{feature}#{punctuation}"
+      without_method = "#{aliased_target}_without_#{feature}#{punctuation}"
+
+      alias_method without_method, target
+      alias_method target, with_method
+
+      case
+      when public_method_defined?(without_method)
+        public target
+      when protected_method_defined?(without_method)
+        protected target
+      when private_method_defined?(without_method)
+        private target
+      end
+    end
   end
 end

data/config/initializers/02_patches/action_dispatch.rb

@@ -0,0 +1,16 @@
+module Patches
+  module ActionDispatch
+    # needed to make rails-dev-tweaks gem to work with rails 5
+    # based on this PR https://github.com/wavii/rails-dev-tweaks/pull/25/files
+    module Reloader
+        def cleanup!
+          ::Rails.application.reloader.reload!
+        end
+
+        def prepare!
+          ::Rails.application.reloader.prepare!
+        end
+    end
+  end
+end
+

data/config/initializers/02_patches/active_job.rb

@@ -0,0 +1,35 @@
+module Patches
+  module ActiveJob
+    # monkeypatch ActiveJob so that it can handle more types of arguments
+    module Arguments
+      CLASS_NAME_KEY = "_aj_class_name_key".freeze
+
+      private
+
+      def serialize_argument argument
+        case argument
+        when Symbol, Time, DateTime
+          { value: argument.to_s, CLASS_NAME_KEY => argument.class.to_s }
+        when ActionController::Parameters
+          { value: serialize_argument(argument.to_unsafe_h),
+            CLASS_NAME_KEY: argument.class.to_s }
+        else
+          super
+        end
+      end
+
+      def deserialize_argument argument
+        return super unless argument.is_a?(Hash) &&
+                            argument[CLASS_NAME_KEY]
+        case argument[CLASS_NAME_KEY]
+        when "Symbol"
+          argument[:value].to_sym
+        when "Time", "DateTime"
+          Object.const_get(argument[CLASS_NAME_KEY]).parse argument[:value]
+        else
+          argument[:value]
+        end
+      end
+    end
+  end
+end

data/config/initializers/patches.rb

@@ -17,3 +17,15 @@ end
 class ActiveRecord::Relation
   include Patches::ActiveRecord::Relation
 end
+
+module ActiveJob::Arguments
+  class << self
+    prepend Patches::ActiveJob::Arguments
+  end
+end
+
+module ActionDispatch
+  class Reloader
+    extend Patches::ActionDispatch::Reloader
+  end
+end

data/config/initializers/recaptcha.rb

@@ -29,9 +29,15 @@ end
 Recaptcha.configure do |config|
   # the seed task runs initializers so we have to check
   # if the cards table is ready before we use it here
+  CONFIG_OPTIONS =
+    {
+      public_key: :site_key,
+      private_key: :secret_key,
+      proxy: :proxy
+    }
   if card_table_ready?
-    [:public_key, :private_key, :proxy].each do |setting|
-      config.send "#{setting}=", load_recaptcha_config(setting)
+    CONFIG_OPTIONS.each do |codename, setting|
+      config.send "#{setting}=", load_recaptcha_config(codename)
     end
   end
 end

data/config/locales/de.yml

@@ -35,10 +35,10 @@ de:
         exception_not_implemented: "%{func} nicht implementiert"
       codename:
         exception_missing_codename: nicht vorhanden %{codename} %{code} (%{const})
-      exceptions:
+      error:
         exception_for_card: "für Karte %{cardname}: %{message}"
       format:
-        render:
+        error:
           exception_bad_arg: "falsches %{category} Argument: %{arg}"
           exception_bad_args: "falsche %{category} Argumente: %{args}"
           no_cardname: unbekannte Karte
@@ -211,11 +211,12 @@ de:
             unfollow: nicht folgen
             follow: folgen
           notify:
+            follow_included: follow cards included by %{cardname}
             followed_card: verfolgte Karte
             follower: follower
             new: neu
             deleted: gelöscht
-            update_changes: "\nDiese Update beinhaltet folgende Änderungen:%{changes}"
+            update_changes: "\nDieses Update beinhaltet folgende Änderungen:%{changes}"
         right:
           follow:
             more_options: mehr Optionen
@@ -406,6 +407,8 @@ de:
             delete_old: delete old
             references: Verweise
             repair_all: alle reparieren
+            view_cache: view cache
+            clear_view_cache: clear view cache
             memory_now: memory now
             clear_cache: clear cache
             # memory previous
@@ -420,13 +423,6 @@ de:
             cards_exist: Entschuldigung, diese Karten muss ein Kartentyp bleiben, solange es noch %{cardname}-Karten gibt.
             add_card: Füge %{cardname} hinzu
             error_cant_alter: kann dieseh Typ nicht ändern; es gibt noch %{name}-Karten
-          file:
-            file_error: Dateifehler
-            download: Download %{title}
-            delete: Löschen
-            add_item: Füge %{attachment_name} hinzu...
-            replace_item: Ersetze %{attachment_name}...
-            ###### REVIEW PAUSED HERE
           list:
             type_right: benötigt einen Kartentypnamen als rechten Teil
             conflict_item_type: name conflicts with list items' type; delete content first
@@ -494,18 +490,6 @@ de:
             sign_in: Anmelden
             invite: Einladen
             sign_out: Abmelden
-          admin_info:
-            email_off: E-Mail-Versand ist ausgeschaltet. Ändere die Einstellungen in %{path}, damit Benachrichtigungen verschickt werden, wenn sich neue Nutzer registrieren.
-            admin_warn: ADMINISTRATOR WARNUNG
-            captcha_temp: Dein Deck arbeitet mit provisorischen Captcha-Einstellungen. Das ist kein Problem für eine lokale Installation, aber falls du diese Seite online stellst, benötigst Du neue Recaptcha-Schlüssel.
-            captcha_keys: Dein Deck ist so konfiguriert, dass es [[*captcha]] nutzt, aber damit das funktioniert, benötigst Du neue Recaptcha-Schlüssel.
-            instructions: Anleitungen
-            howto_add_keys: "Neue Recaptcha-Schlüssel hinzufügen:"
-            howto_register: 1. Registriere deine Domain bei %{recaptcha_link}
-            howto_add: 2. Füge deine Schlüssel zu %{recaptcha_settings} hinzu
-            howto_turn_off: 'Captcha ausschalten:'
-            howto_go: 1. Gehe zu %{captcha_card}
-            howto_update: 2. Ändere alle *captcha-Regeln zu "no".
           signin:
             sign_in_title: Anmelden
             sign_in: Anmelden
@@ -547,4 +531,33 @@ de:
             get_started: Um loszulegen, erstelle einen Account.
             email_off: "WARNING: E-Mail-Versand ist deaktiviert. Ändere die Einstellung in %{path} um bei neuen Registrierungen Benachrichtigungen zu senden."
             set_up: Anlegen
-            setting_up: Lege an
+            setting_up: Lege an
+    :carrierwave:
+      set:
+        abstract:
+          attachment:
+            error_invalid_storage_type: "%{type} is not a valid file storage option"
+        type:
+          file:
+            file_error: Dateifehler
+            download: Download %{title}
+            delete: Löschen
+            add_item: Füge %{attachment_name} hinzu...
+            replace_item: Ersetze %{attachment_name}...
+            ###### REVIEW PAUSED HERE
+    :admin:
+      set:
+        self:
+          admin_info:
+            email_off: E-Mail-Versand ist ausgeschaltet. Ändere die Einstellungen in %{path}, damit Benachrichtigungen verschickt werden, wenn sich neue Nutzer registrieren.
+            admin_warn: ADMINISTRATOR WARNUNG
+            captcha_temp: Dein Deck arbeitet mit provisorischen Captcha-Einstellungen. Das ist kein Problem für eine lokale Installation, aber falls du diese Seite online stellst, benötigst Du neue Recaptcha-Schlüssel.
+            captcha_keys: Dein Deck ist so konfiguriert, dass es [[*captcha]] nutzt, aber damit das funktioniert, benötigst Du neue Recaptcha-Schlüssel.
+            instructions: Anleitungen
+            howto_add_keys: "Neue Recaptcha-Schlüssel hinzufügen:"
+            howto_register: Registriere deine Domain bei %{recaptcha_link}
+            howto_add: Füge deine Schlüssel zu %{recaptcha_settings} hinzu
+            howto_turn_off: 'Captcha ausschalten:'
+            howto_go: Gehe zu %{captcha_card}
+            howto_update: Ändere alle *captcha-Regeln zu "no".
+