compony 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2eb1aa6e1437a93c6ecaba6fe39bca1f38dc9f3c5b2f64bc7bfeaba35b1df531
-  data.tar.gz: 58ff003601a8b4cabe7bfcf0dd0669e496778949251abe1022fbbb2d10b6114f
+  metadata.gz: 7c86661ace81edbc9e70bafc696e79ec4f6b841f922101438c9e3045961abc97
+  data.tar.gz: 0c64af093433a17038dbf61cfafaf29f055c8bc17b34b2b533ad197fc6bb2185
 SHA512:
-  metadata.gz: 805e0ecdd02f8dbbecd8d28253960d734ad8fc504efbf61c362a579ce6f36cd502067e40f88ea8cf94af8defd84b5cf56a727487bc7d4abbf0d67b6a0a56a0b9
-  data.tar.gz: c81f256fa241c2eaad5767f97c257c6ab5754b9c19ce72054fa6dc67e82c951e029575698b8a82b40ba087559ef5af9fb12cc04868c59eec625be5a0743c2f84
+  metadata.gz: c45a94a487cf2ed9073ab09ec4728923142be3b28086746b42bb11a9b920520d5df949214e37f3dba43946a6f68627af7f522725b07b500a6774b3d8ff6ac433
+  data.tar.gz: b228eb689d514810a2bad4f53187899d4d931b5cd70979cd3447b9fe5bf29e2b05faa1352e7a87d6ee1a270f70a789e7934b4ff95b221ec3f0874a56de607850

data/CHANGELOG.md

@@ -1,3 +1,42 @@
+# 0.8.0
+
+Be advised that this version brings major interface changes that will break existing applications. When upgrading, carefully follow sthe steps unter "Steps to take" and test your application thoroughly.
+
+- Add `render_sub_comp` helper
+- Major API change: implement `Compony::Intent` as discussed in Issue #14:
+    - Rewire many pure helpers to use intents instead, greatly cleaning up their interface
+    - Remove pure helpers `rails_action_name`, `path_helper_name`, `comp_cst` and `family_cst`
+    - Remove `button_defaults` and associated logic, as it was rarely used
+    - Remove `Compony::Components::Button` and replace it by `Compony::Components::Buttons::Link` and `Compony::Components::Buttons::CssButton`
+    - Remove `Compony.button`, `compony_button` and `compony_link`
+    - Use intents in `sub_comp` and thus also in `resourceful_sub_comp`, allowing tho write something like `sub_comp :list, user.quotes`
+- Update documentation
+
+## Steps to take
+
+- Make sure you no longer use the following methods that have been removed:
+    - `Compony.rails_action_name`
+    - `Compony.path_helper_name`
+    - `Compony.button_defaults`
+    - `Compony.with_button_defaults`
+    - `Compony.button_component_class=` (replace by button styles, see documentation)
+    - `Component.comp_cst` (replace by `comp_name`)
+    - `Component.family_cst` (replace by `family_name`)
+- If using custom buttons, inherit from `Compony::Components::Buttons::Link` and adjust code as needed. Register your button with `Compony.register_button_style` and consider setting `Compony.default_button_style=`.
+- Search for each following keywords in your application and replace it as follows:
+    - Replace root actions (`action ... do` and `skip_action`)  by exposed intents (see documentation).
+    - Replace `render_actions` or `compony_actions` by a custom loop of the kind `Compony.root_comp&.exposed_intents&.map { |i| i.render(controller) }`
+    - Replace buttons and change any `params:` to `path:`; as well as `label_format` or `label_opts: { format: ... }` by something like: `render_intent(:show, @data, button: { label: { format: :short } })`:
+      - `Compony.button` was typically used in a component's root actions and should thus already have been replaced in the previous step.
+      - Replace `compony_button` by `render_intent`
+      - Replace `compony_link` by `render_intent` and pass `button: { style: :link }` as an argument
+- Enhancement: Consider replacing patterns like `sub_comp(Components::Quotes::List, data: user.quotes).render(controller)` by `render_sub_comp(:list, user.quotes)`.
+
+# 0.7.1
+
+- Implement `Compony::VirtualModel` and document it in the Readme file
+- Break up documentation into separate files
+
 # 0.7.0
 
 - Rename Component's internal `path` to `id_path` to distinguish it from Rails paths, as well as `path_hash` to `id_path_hash`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    compony (0.6.5.edge)
+    compony (0.7.2.edge)
       anchormodel (~> 0.2.1)
       cancancan (~> 3.6.1)
       dslblend (>= 0.0.3)