azahara_schema 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fdc281f1678559822f32f72ae8dc63a8ae3cb0c
-  data.tar.gz: 94a238cae3c82df5573c651a81d9b5d0ea3e78f1
+  metadata.gz: 97da3d5692c281b23103b2f29bb7d000e9a9a47d
+  data.tar.gz: 6650308c13f3b416394d6899067768300f6a022a
 SHA512:
-  metadata.gz: 0b5c33963f165442367dcb014f17b5d287094cda153da630815eae239bcf6fc166f40591339be34932d3dc4fba02154a876ed672ab9d78ba369f08f4727fda33
-  data.tar.gz: c3bb384bcde4c9a27881c86b39ca42ccc120b2f3d8b80b3470754e4f8bbaea8f82f01d8ddcd22b9790a1a54c79bea3cd651ba09b6b1b57e4667bbdf421afa838
+  metadata.gz: b5a10fdff991b788f56fe2ffe2f3c72f65d3f8feea779dc5766706a31bc69130cbc2154014b78cd0088713400ae09f2d81b72d2130066f468ddc4432716a57e6
+  data.tar.gz: 7a1f06279dfeed7351b9d10bbaeb9b5c3f0196c3d2fa6a26f29a4e1951599b56744b433e8e74266c81bd5f30b0e37bee7a06a1bac402b322fdbcab04e6b85247

data/README.md

@@ -1,8 +1,14 @@
+[![pipeline status](https://git.servis.justice.cz/libraries/azahara_schema/badges/master/pipeline.svg)](https://git.servis.justice.cz/libraries/azahara_schema/commits/master)
+
 # AzaharaSchema
 
+Azahara schema helps you to work with your model view.
+Its basic usage is for your index method. But can be used even as a master-detail component.
 
-## Usage
-How to use my plugin.
+* It defines filters for you.
+* It renders json responses for you
+* Defines easy api over you model
+* Lets you define your own outputs and manages them for you.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,6 +27,52 @@ Or install it yourself as:
 $ gem install azahara_schema
 ```
 
+## Usage
+Default usage is only for Rails.
+
+You basically need just this:
+```ruby
+@schema = AzaharaSchema::Schema.new(Model)
+```
+
+But you can ovewrite the default behaviour. Just inherit from AzaharaSchema::ModelSchema
+```ruby
+class UserSchema < AzaharaSchema::ModelSchema
+end
+
+UserSchema.new
+```
+
+Azahara takes the name of model before Schema and uses it for looking for model class.
+Alternatively you can overwrite method ```model``` and let it return class for your model.
+
+
+### Defining enabled/disabled filters
+
+In your inherited class you can globally set enabled filter - for azahara not to populate unwanted parameters of your model.
+```ruby
+self.enabled_filters 'attr_name1', 'attr_name2'
+```
+Second option is defining those on instance - it is preferable solution and is more straight forward.
+Here you can even solve the permissions.
+```ruby
+def enabled_filters
+  filters = ['attr_name1', 'attr_name2']
+  filters << 'attr_name3' if User.current.admin?
+  filters
+end
+```
+Alternative for it is just black list attributes you do not want to have as filters.
+```ruby
+def disabled_filters
+  to_disable = []
+  to_disable << ['attr_name3'] if !User.current.admin?
+  to_disable
+end
+```
+Or you can use all those methods together.
+
+
 ## Contributing
 Contribution directions go here.
 

data/lib/azahara_schema/attribute.rb

@@ -66,6 +66,8 @@ module AzaharaSchema
         scope.where( arel_field.gteq(values) )
       when '<='
         scope.where( arel_field.lteq(values) )
+      else
+        throw 'Unknown operator ' + operator.to_s
       end
     end
 

data/lib/azahara_schema/field_format.rb

@@ -59,6 +59,10 @@ module AzaharaSchema
       add 'float'
     end
 
+    class DecimalFormat < FloatFormat
+      add 'decimal'
+    end
+
     class BooleanFormat < Base
       add 'boolean'
     end

data/lib/azahara_schema/schema.rb

@@ -1,3 +1,5 @@
+require 'active_support' #Hash.slice
+
 module AzaharaSchema
   class Schema
 
@@ -35,6 +37,11 @@ module AzaharaSchema
       @column_names = attributes[:columns]
     end
 
+    def column_names=(values)
+      @column_names = values
+      @columns = nil
+    end
+
     def column_names
       @column_names ||= default_columns
     end
@@ -116,15 +123,22 @@ module AzaharaSchema
     end
 
     def enabled_filters
-      if self.class.enabled_filters.any?
-        self.class.enabled_filters.collect{|f_name| available_attributes.detect{|attr| attr.name == f_name } }.compact
-      else
-        available_attributes
-      end
+
+    end
+
+    def disabled_filters
+      []
+    end
+
+    def enabled_filter_names
+      names = self.class.enabled_filters if self.class.enabled_filters.any?
+      names ||= available_attributes_hash.keys
+      names &= enabled_filters if enabled_filters
+      names -= disabled_filters
     end
 
     def available_filters
-      @available_filters ||= enabled_filters.select{|att| att.filter? }.collect{|att| [att.filter_name, att] }.to_h
+      @available_filters ||= available_attributes_hash.slice(*enabled_filter_names)
     end
 
     def available_associations
@@ -185,6 +199,9 @@ module AzaharaSchema
         filter_params = params[:f].permit(available_filters.keys).to_h
         filter_params.each{|name, short_filter| add_short_filter(name, short_filter) }
       end
+      if params[:c].is_a?(Array)
+        self.column_names = params[:c].to_a
+      end
       if params[:sort]
         @sort = nil
         params[:sort].each do |k, sort|
@@ -199,6 +216,7 @@ module AzaharaSchema
       filters.each do |fname, attrs|
         params[:f][fname] = "#{attrs[:o]}|#{attrs[:v]}"
       end
+      params[:c] = column_names
       params
     end
 

data/lib/azahara_schema/version.rb

@@ -1,3 +1,3 @@
 module AzaharaSchema
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azahara_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ondřej Ezr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Gem to support developement of rails application with schema over an entity