symphonia 3.1.5 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa7ffaee9227f92a65343e7ceb49c1b456a55979dee59eb58084315f9395c4ff
-  data.tar.gz: 863eab3a706edd2db29cbe2929fb9c4a873bd57bbe7516dd1aced6c3b844693c
+  metadata.gz: 6b48c59788b2e00b86be3e0db6b90f15833b9b26668673aa56c41a676ebca438
+  data.tar.gz: 3fa0287a83b8463b1e2a630ce39dd0ad49d7810ed7aefafbaffce517219bea3c
 SHA512:
-  metadata.gz: 254b4b7854e3ea0e0c86fb8a97774db2947212d88611e32e4758d02fadd4d4b7d9ff4205eb15f82bc3c7fda78ab6f56b740693c02b3b4f085b9607a509b9f93f
-  data.tar.gz: 931719ab8a002fa957fb9091960417d0a4a9b7b30bc9f4aa2d8244989b910aa43b79c7dc5afe32102f82bc541944f656c79e573c26a8d45922cde248e16b95db
+  metadata.gz: c588275faf8d81e32e22b71fc9cf0cbbdb66ee3b6f328aa83540d0129b513368f51294813535eda0432ae6c8681497cbd83484f2d9947b48985b5408dece2b99
+  data.tar.gz: f5a33405a69db155dda2ef9fa8527f066d5bf995b3618baad9d465936943fc379320a28c1a468077a882ced2f4e9a875bbc32a855eb0f1bf9fe78da754e4575a

data/.rubocop.yml

@@ -1,7 +1,3 @@
-#require:
-#  - rubocop-rails
-All:
-  Rails: true
 AllCops:
   TargetRubyVersion: 2.5
 
@@ -16,13 +12,13 @@ Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:
   Enabled: false
-Metrics/LineLength:
-  Enabled: false
+#Metrics/LineLength:
+#  Enabled: false
 Metrics/MethodLength:
   Enabled: false
 
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
+#Style/BracesAroundHashParameters:
+#  EnforcedStyle: context_dependent
 Style/Documentation:
   Enabled: false
 Style/MutableConstant:

data/app/assets/javascripts/symphonia/symphonia_ckeditor.js

@@ -1,4 +1,3 @@
-//= require ckeditor-jquery
 //= require_self
 
 CKEDITOR.editorConfig = function( config )

data/app/controllers/concerns/symphonia/swagger/base_controller.rb

@@ -0,0 +1,134 @@
+module Symphonia
+  module Swagger
+    module BaseController
+      extend ActiveSupport::Concern
+      # General swagger description
+      #
+      # How to use:
+      # `include Symphonia::Swagger::BaseController`
+      # # it include all necessary methods then you need call
+      # `swagger_me entity: "MyModelName", base_path: "/my_entities"`
+      # for change which tags list are used with all this endpoints override method `tag_list`
+      #
+      class_methods do
+
+        # @param [String] name of swagger model
+        def entity=(name)
+          @entity = name
+        end
+
+        # @param [String] path - route
+        def base_path=(path)
+          @base_path = path
+        end
+
+        # @abstract guess entity name from controller
+        def entity
+          @entity || name.demodulize.remove("Controller").singularize
+        end
+
+        # @abstract base route to described controller
+        def base_path
+          @base_path || "/#{entity_name.pluralize}"
+        end
+
+        # @abstract name used in params
+        def entity_name
+          entity.underscore
+        end
+
+        # @return [Array]
+        def tag_list
+          [entity]
+        end
+
+        # @param [String] entity is singular name of described model
+        # @param [String] base_path in URL where is model located in app
+        def swagger_me(entity: name.demodulize.remove("Controller").singularize, base_path: nil)
+          self.entity = entity
+          self.base_path = base_path || "/#{entity_name.pluralize}"
+          include GeneralDefinitions
+        end
+
+      end
+      module GeneralDefinitions
+        extend ActiveSupport::Concern
+        included do
+          include ::Swagger::Blocks
+
+          base = self
+          swagger_path "#{base.base_path}.json" do
+            operation :get do
+              key :summary, "List"
+              key :tags, base.tag_list
+              parameter do
+                key :name, "q"
+                key :description, "free-text filter of current entity - `like`"
+                key :in, "query"
+                schema type: "string"
+              end
+              parameter do
+                key :name, "set_filter"
+                key :description, "enable filtering"
+                key :in, "query"
+                schema type: "boolean"
+              end
+              parameter do
+                key :name, "sort"
+                key :description, "name of 'column' for sort. Can be also in format name:asc or :desc"
+                key :example, "email:desc (for reverse order users by e-mail"
+                key :in, "query"
+                schema type: "string"
+              end
+              parameter do
+                key :name, "page"
+                key :description, "number of requested page"
+                key :in, "query"
+                schema type: "integer"
+              end
+              extend Symphonia::Swagger::Responses
+              response 200 do
+                key :description, "ok"
+                content "application/json" do
+                  schema type: "array" do
+                    items do
+                      key "$ref", base.entity
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          swagger_path "#{base.base_path}/{id}.json" do
+            operation :get do
+              key :summary, 'Find by ID'
+              key :description, 'Returns a single entity'
+              key :tags, base.tag_list
+              parameter do
+                key :name, "id"
+                key :in, "path"
+                key :description, 'ID to fetch'
+                key :required, true
+                schema do
+                  key :type, "integer"
+                  key :format, "int64"
+                end
+              end
+              extend Symphonia::Swagger::Responses
+              response 200 do
+                key :description, 'detail object response'
+                content "application/json" do
+                  schema do
+                    key :'$ref', base.entity
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/app/controllers/symphonia/api_controller.rb

@@ -2,13 +2,19 @@ module Symphonia
   class ApiController < ApplicationController
     include ::Swagger::Blocks
     # https://github.com/fotinakis/swagger-blocks
-    swagger_root do
-      key :swagger, '2.0'
+    swagger_component do
+      security_scheme "token" do
+        key :type, "apiKey"
+        key :name, "key"
+        key :in, "header"
+      end
+    end
+
+    swagger_root openapi: "3.0.0" do
       info do
-        key :version, '1.0.0'
-        key :title, 'Symphonia API'
-        key :description, ''
-        # key :termsOfService, 'http://helloreverb.com/terms/'
+        key :version, '2.0.0'
+        key :title, "API"
+        key :description, ""
         contact do
           key :name, 'Lukas Pokorny'
           key :email, 'pokorny@luk4s.cz'
@@ -17,36 +23,16 @@ module Symphonia
           key :name, 'GPLv3'
         end
       end
-      # tag do
-      #   key :name, 'pet'
-      #   key :description, 'Pets operations'
-      #   externalDocs do
-      #     key :description, 'Find more info here'
-      #     key :url, 'https://swagger.io'
-      #   end
-      # end
-      # key :host, 'petstore.swagger.wordnik.com'
-      key :basePath, '/'
-      key :consumes, ['application/json']
-      key :produces, ['application/json']
 
-      security_definition :token do
-        key :type, :apiKey
-        key :name, :Authorization
-        key :in, :header
-      end
       security do
         key :token, []
       end
-      # security_definition :petstore_auth do
-      #   key :type, :oauth2
-      #   key :authorizationUrl, 'http://swagger.io/api/oauth/dialog'
-      #   key :flow, :implicit
-      #   scopes do
-      #     key 'write:pets', 'modify pets in your account'
-      #     key 'read:pets', 'read your pets'
-      #   end
-      # end
+
+      tag name: "admin" do
+        key :description, "endpoints required `admin`"
+      end
+      tag name: "User" do
+      end
     end
 
     # A list of all classes that have swagger_* declarations.
@@ -54,11 +40,39 @@ module Symphonia
       UsersController,
       User,
       Swagger::ErrorModel,
-      self
     ]
+    def self.for_documentation
+      SWAGGERED_CLASSES + Symphonia::ApiController::SWAGGERED_CLASSES
+    end
+
+    # @param [String] name of tag
+    # @param [String] description
+    def self.add_tag(name:, description:)
+      swagger_root_node.tag name: name, description: description
+    end
+
+    # @return [Swagger::Blocks::Nodes::RootNode]
+    def self.swagger_root_node
+      node = Symphonia::ApiController.send(:_swagger_nodes)
+      node[:root_node]
+    end
+
+    # @param [String] text
+    def self.api_title=(text)
+      swagger_root_node.data[:info].data[:title] = text
+    end
+
+    # @param [String] text
+    def self.api_description=(text)
+      swagger_root_node.data[:info].data[:description] = text
+    end
 
     def index
-      render json: ::Swagger::Blocks.build_root_json(SWAGGERED_CLASSES)
+      json = ::Swagger::Blocks.build_root_json(self.class.for_documentation + [self.class])
+      respond_to do |format|
+        format.yaml { render plain: json.deep_stringify_keys.to_yaml }
+        format.json { render json: json }
+      end
     end
   end
 end

data/app/controllers/symphonia/user_sessions_controller.rb

@@ -8,7 +8,7 @@ module Symphonia
     end
 
     def current_session
-        current_user_session
+      current_user_session
     end
 
   end

data/app/controllers/symphonia/users_controller.rb

@@ -1,38 +1,10 @@
 module Symphonia
   class UsersController < ApplicationController
-    include ::Swagger::Blocks
-
-    swagger_path '/admin/users/{id}.json' do
-      operation :get do
-        key :summary, 'Find User by ID'
-        key :description, 'Returns a single user if the user has access'
-        # key :operationId, 'findPetById'
-        # key :tags, [
-        #   'pet'
-        # ]
-        parameter do
-          key :name, :id
-          key :in, :path
-          key :description, 'ID of user to fetch'
-          key :required, true
-          key :type, :integer
-          key :format, :int64
-        end
-        extend Symphonia::Swagger::Responses
-        response 200 do
-          key :description, 'user response'
-          schema do
-            key :'$ref', :User
-          end
-        end
-        # response :default do
-        #   key :description, 'unexpected error'
-        #   schema do
-        #     key :'$ref', :ErrorModel
-        #   end
-        # end
-      end
+    include Symphonia::Swagger::BaseController
+    def self.tag_list
+      %w[User admin]
     end
+    swagger_me entity: "User", base_path: "/admin/users"
 
     helper Symphonia::RendererHelper
 

data/app/helpers/symphonia/form_helper.rb

@@ -4,8 +4,6 @@ module Symphonia
     def symphonia_form_for(object, options={}, &block)
       options.reverse_merge!(builder: Symphonia::FormBuilder)
 
-      options = process_options(options)
-
       unless options[:remote] && options[:local].nil?
         options[:local] = true
       end

data/app/models/symphonia/swagger/error_model.rb

@@ -3,15 +3,20 @@ module Symphonia
     class ErrorModel
       include ::Swagger::Blocks
 
-      swagger_schema :ErrorModel do
-        key :required, %i[attribute messages]
-        property :attribute do
-          key :type, :string
-          key :example, "login"
-        end
-        property :messages do
-          key :type, :array
-          key :example, "[cannot be blank]"
+      swagger_component do
+        schema :ErrorModel do
+          key :required, %w[attribute messages]
+          property :attribute do
+            key :type, "string"
+            key :example, "login"
+          end
+          property :messages do
+            key :type, "array"
+            items do
+              key :type, "string"
+              key :example, "cannot be blank"
+            end
+          end
         end
       end
     end

data/app/models/symphonia/swagger/parameters.rb

@@ -0,0 +1,21 @@
+module Symphonia
+  module Swagger
+    module Parameters
+      def self.extended(base)
+
+        base.parameter do
+          key :name, "format"
+          key :description, "specify format of response"
+          key :in, "path"
+          key :required, true
+          schema do
+            key :type, "string"
+            key :enum, %w[json]
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/app/models/symphonia/swagger/responses.rb

@@ -13,8 +13,8 @@ module Symphonia
         end
         base.response 422 do
           key :description, 'unprocessable entity'
-          schema do
-            key :'$ref', :ErrorModel
+          content "application/json" do
+            schema "$ref": "ErrorModel"
           end
         end
         base.response 500 do

data/app/models/symphonia/user.rb

@@ -31,26 +31,27 @@ module Symphonia
     include UserManagement
 
     include ::Swagger::Blocks
-
-    swagger_schema :User do
-      key :required, %i[id login email]
-      property :id do
-        key :type, :integer
-        key :format, :int64
-      end
-      property :fist_name do
-        key :type, :string
-      end
-      property :last_name do
-        key :type, :string
-      end
-      property :email do
-        key :type, :string
-        key :format, :email
-      end
-      property :status do
-        key :type, :string
-        key :enum, Symphonia::User.statuses.keys
+    swagger_component do
+      schema :User do
+        key :required, %w[id login email]
+        property :id do
+          key :type, "integer"
+          key :format, "int64"
+        end
+        property :fist_name do
+          key :type, "string"
+        end
+        property :last_name do
+          key :type, "string"
+        end
+        property :email do
+          key :type, "string"
+          key :format, "email"
+        end
+        property :status do
+          key :type, "string"
+          key :enum, Symphonia::User.statuses.keys
+        end
       end
     end
 
@@ -155,7 +156,7 @@ module Symphonia
       end
 
       def language
-        Symphonia.config.default_locale || I18n.default_locale
+        nil
       end
     end
 

data/db/migrate/20200428180001_add_uuid_to_users.rb

@@ -0,0 +1,6 @@
+class AddUuidToUsers < ActiveRecord::Migration[6.0]
+  def change
+    uuid_type = connection.adapter_name =~ /PostgreSQL/i ? :uuid : :string
+    add_column :users, :uuid, uuid_type
+  end
+end

data/db/migrate/20200428180008_add_avatar_to_users.rb

@@ -0,0 +1,5 @@
+class AddAvatarToUsers < ActiveRecord::Migration[6.0]
+  def change
+    add_column :users, :avatar_url, :string
+  end
+end

data/db/seeds.rb

@@ -6,7 +6,8 @@ u.attributes = {
   email: 'luk4s.pokorny@gmail.com',
   password: 'admin',
   # password_confirmation: 'admin',
-  admin: true
+  admin: true,
+  avatar_url: "https://secure.gravatar.com/avatar/3657d5f0e9747c1c21eb2b689a8dba0b?s=64"
 }
 u.single_access_token = SecureRandom.hex(20)
 u.save!(validate: false)

data/lib/generators/symphonia/setup/setup_generator.rb

@@ -16,7 +16,8 @@ module Symphonia
     end
 
     def copy_assets
-      append_to_file 'app/assets/javascripts/application.js', '//= require symphonia/application'
+      template 'app/assets/javascripts/application.js'
+      append_to_file 'app/assets/config/manifest.js', '//= link symphonia_manifest.js'
       copy_file 'design.scss', 'app/assets/stylesheets/general.scss'
     end
 

data/lib/generators/symphonia/setup/templates/app/assets/javascripts/application.js.tt

@@ -0,0 +1 @@
+//= require symphonia/application

data/lib/symphonia/base_controller.rb

@@ -6,10 +6,17 @@ module Symphonia
   # def model
   #   YourModel
   # end
+  # OR
+  # self.model = YourModel
   #
   # def safe_attributes
   #   %i[]
   # end
+  #
+  # def swagger_path
+  #  false # => for disable swagger
+  #   "/my-custom-path" # => for custom route
+  # end
   module BaseController
     extend ActiveSupport::Concern
 
@@ -24,6 +31,7 @@ module Symphonia
       # @param [Class] model
       class_attribute :model
 
+      include Symphonia::Swagger::BaseController
     end
 
     class_methods do

data/lib/symphonia/engine.rb

@@ -83,10 +83,10 @@ module Symphonia
 
     initializer :assets do |_app|
       config.assets.precompile << 'symphonia/application.css'
-      if defined?(::Ckeditor)
-        config.assets.precompile << 'ckeditor/**/*'
-        config.assets.precompile << 'symphonia/symphonia_ckeditor.js'
-      end
+      #if defined?(::Ckeditor)
+      #  config.assets.precompile << 'ckeditor/**/*'
+      #  config.assets.precompile << 'symphonia/symphonia_ckeditor.js'
+      #end
     end
 
     initializer :symphonia_general_permissions do |_app|

data/lib/symphonia/model_attributes/attribute.rb

@@ -174,7 +174,7 @@ module Symphonia
 
     class DateTimeAttribute < Attribute
       def format_value(view, value, entity)
-        value && view.l(value, format_options)
+        value && view.l(value.localtime, format_options)
       end
     end
     class DatetimeAttribute < DateTimeAttribute

data/lib/symphonia/version.rb

@@ -1,3 +1,3 @@
 module Symphonia
-  VERSION = '3.1.5'
+  VERSION = '3.2.1'
 end

data/spec/controllers/api_controller_spec.rb

@@ -3,7 +3,7 @@ module Symphonia
     routes { Symphonia::Engine.routes }
 
     it "#index" do
-      get :index
+      get :index, params: {format: "yml"}
     end
   end
 end

data/spec/controllers/base_controller_spec.rb

@@ -17,16 +17,21 @@ class DummyBaseA < Symphonia::ApplicationController
   self.model = ModelA
 end
 class DummyBaseB < DummyBaseA
-  # include Symphonia::BaseController
   self.model = ModelB
 end
 
 RSpec.describe DummyBaseB do
-  # subject { described_class.new }
+
   controller do
+    before_action :set_locale, only: :index
+
     def show
       render plain: model.name
     end
+
+    def index
+      render plain: t(:language)
+    end
   end
   it "#model" do
     subject = DummyBaseA.new
@@ -39,4 +44,34 @@ RSpec.describe DummyBaseB do
     get :show, params: { id: 1 }
     expect(response.body).to eq "ModelB"
   end
+
+  describe "#set_locale" do
+    before do
+      I18n.locale = :cs
+    end
+    context "logged user", logged: true do
+      before { Symphonia::User.current.language = :cs }
+      it "enforce language of user" do
+        get :index
+        expect(response.body).to eq "Čeština"
+        Symphonia::User.current.language = :en
+        get :index
+        expect(response.body).to eq "English"
+      end
+
+      it "ignore :locale params" do
+        get :index, params: { locale: "en" }
+        expect(response.body).to eq "Čeština"
+      end
+    end
+    it "anonymous default language" do
+      get :index
+      expect(response.body).to eq "Čeština"
+    end
+
+    it "anonymous language by :locale" do
+      get :index, params: { locale: "en" }
+      expect(response.body).to eq "English"
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ Dir.glob(File.expand_path('../support/*.rb', __FILE__)).each do |file|
   require file
 end
 
-ActiveRecord::Migration.maintain_test_schema!
+# ActiveRecord::Migration.maintain_test_schema!
 
 Paperclip::Attachment.default_options[:path] = "#{Rails.root}/spec/test_files/:class/:id_partition/:style.:extension"
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: symphonia
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.2.1
 platform: ruby
 authors:
 - Lukas Pokorny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -240,14 +240,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: 4.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: 4.4.0
 - !ruby/object:Gem::Dependency
   name: the_sortable_tree
   requirement: !ruby/object:Gem::Requirement
@@ -310,14 +310,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -450,6 +450,7 @@ files:
 - app/assets/stylesheets/symphonia/symphonia_bootstrap.scss
 - app/channels/application_cable/channel.rb
 - app/controllers/base_controller.rb
+- app/controllers/concerns/symphonia/swagger/base_controller.rb
 - app/controllers/symphonia/accounts_controller.rb
 - app/controllers/symphonia/admin_controller.rb
 - app/controllers/symphonia/api_controller.rb
@@ -476,6 +477,7 @@ files:
 - app/models/symphonia/preference.rb
 - app/models/symphonia/role.rb
 - app/models/symphonia/swagger/error_model.rb
+- app/models/symphonia/swagger/parameters.rb
 - app/models/symphonia/swagger/responses.rb
 - app/models/symphonia/user.rb
 - app/models/symphonia/user_session.rb
@@ -545,6 +547,8 @@ files:
 - db/migrate/20130828175114_create_attachments.rb
 - db/migrate/20141213204351_create_admin_modules.rb
 - db/migrate/20190706130409_add_external_id_to_users.rb
+- db/migrate/20200428180001_add_uuid_to_users.rb
+- db/migrate/20200428180008_add_avatar_to_users.rb
 - db/seeds.rb
 - lib/generators/symphonia/entity_controller/entity_controller_generator.rb
 - lib/generators/symphonia/entity_controller/templates/controller.rb
@@ -553,6 +557,7 @@ files:
 - lib/generators/symphonia/setup/templates/404.html
 - lib/generators/symphonia/setup/templates/500.html
 - lib/generators/symphonia/setup/templates/Gemfile
+- lib/generators/symphonia/setup/templates/app/assets/javascripts/application.js.tt
 - lib/generators/symphonia/setup/templates/base_layout.html.erb
 - lib/generators/symphonia/setup/templates/design.scss
 - lib/generators/symphonia/setup/templates/settings.rb