filemaker 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a0fc57ed0ca37fe2baa601b0e3de5c4f269a087
-  data.tar.gz: 4dcbee5913ba864cbdbb45744e678d7a22de9730
+  metadata.gz: 87dee5e465c260a70cc59492b12fb5a8a9f74dce
+  data.tar.gz: dec6305d44d0eac91f95ba7f5def8ddb8a179292
 SHA512:
-  metadata.gz: 08a4d7aaccb0fa6e22091422e7df6c7499ba3072cc815750944791aab70a28de3ac680eab3f3a0fa99b865305955055969602110ff1106aea9c55a535dc7fc20
-  data.tar.gz: ff5323e65f4a4184dc8bd46909081c2f07cfe75112f2447097452140f9aa317b0cff72f62ad3c6bcdd6e86598fe9e3918049b562d8f71bf026f8fff9f6378d87
+  metadata.gz: 182382127660a2e3d081d4b12e80defbeca9db11042a29d4cb626f99ce8bebf016d3b89d16ec1392d4375035d77b5a2ca5450d2c623e6fb7bf3ab4f8b06a5cef
+  data.tar.gz: 3fbc5b636c7fda5f4d8f72b29305844d7777969adeea0b446cd72c6cbfcad98fb404b70e4029ebeb74a1fcd22f2bd1ae4be1a5cde69be9593f82b9a76bd3113e

data/.rubocop.yml

@@ -3,6 +3,7 @@ AllCops:
     - .bundle/**
     - filemaker.gemspec
     - lib/filemaker/errors.rb
+    - lib/generators/filemaker/model/templates/model.rb
 
 Documentation:
   Enabled: false
@@ -14,4 +15,10 @@ MethodLength:
   Enabled: false
 
 LineLength:
-  Max: 80
+  Max: 80
+
+SpecialGlobalVars:
+  Enabled: false
+
+PredicateName:
+  Enabled: false

data/lib/filemaker/elasticsearch/filemaker_adapter.rb

@@ -0,0 +1,28 @@
+module Filemaker
+  module Elasticsearch
+    module FilemakerAdapter
+      module Records
+        def records
+          criteria = klass.in(klass.identity.name => ids)
+
+          criteria.instance_exec(response.response['hits']['hits']) do |hits|
+            define_singleton_method :to_a do
+              self.entries.sort_by do |e|
+                hits.index { |hit| hit['_id'].to_s == e.id.to_s }
+              end
+            end
+          end
+
+          criteria
+        end
+      end
+
+      module Callbacks
+        # noop
+      end
+
+      module Importing
+      end
+    end
+  end
+end

data/lib/filemaker/errors.rb

@@ -80,7 +80,7 @@ module Filemaker
     end
 
     def self.error_message_by_code(code)
-      "FileMaker Error: #{code} (#{DESCRIPTION.fetch(code.to_s) { '??' }})"
+      "#{code} (#{DESCRIPTION.fetch(code.to_s) { '??' }})"
     end
 
     def self.find_error_class_by_code(code)

data/lib/filemaker/metadata/field.rb

@@ -49,7 +49,7 @@ module Filemaker
           rescue
             # We could be getting back these date:
             # '17.12.95', '19/05/99', '27/11 /1981'
-            # '1959-07-03' will be beyong us, so consider returning nil
+            # '1959-07-03' will be beyond us, so consider returning exact value
             value = value.gsub(/-|\./, '/')
             split = value.split('/').map(&:strip)
             split[2] = "19#{split[2]}" if split[2].size == 2

data/lib/filemaker/model/builder.rb

@@ -21,7 +21,8 @@ module Filemaker
             field = klass.find_field_by_name(fm_field_name)
             next unless field
 
-            object.public_send("#{field.name}=", record[fm_field_name])
+            # Because we are using ActiveModel::Dirty, so we hydrate directly.
+            object.attributes[field.name] = field.coerce(record[fm_field_name])
           end
 
           models << object

data/lib/filemaker/model/components.rb

@@ -14,6 +14,7 @@ module Filemaker
       end
 
       include ActiveModel::Model
+      include ActiveModel::Dirty
       include ActiveModel::Serializers::JSON
       include ActiveModel::Serializers::Xml
       include ActiveModel::Validations::Callbacks

data/lib/filemaker/model/field.rb

@@ -13,9 +13,13 @@ module Filemaker
         @fm_name = (options.fetch(:fm_name) { name }).to_s.downcase
       end
 
-      # From FileMaker to Ruby
+      # From FileMaker to Ruby.
+      #
+      # If the value is `==` (match empty) or `=*` (match record), then we will
+      # skip coercion.
       def coerce(value)
         return nil if value.nil?
+        return value if value == '==' || value == '=*'
 
         if @type == String
           value.to_s
@@ -32,6 +36,9 @@ module Filemaker
         else
           value
         end
+      rescue
+        warn "Could not coerce #{name}: #{value}"
+        value
       end
     end
   end

data/lib/filemaker/model/fields.rb

@@ -2,16 +2,29 @@ require 'filemaker/model/field'
 
 module Filemaker
   module Model
+    # `Fields` help to give `Model` their perceived schema. To find out your
+    # fields, use `Model.fm_fields` or use Rails generator like:
+    #
+    #   rails generate filemaker:model filename database layout
+    #
+    # @example
+    #   class Model
+    #     include Filemaker::Model
+    #
+    #     string :id, identity: true
+    #     string :title, fm_name: 'A_Title', default: 'Untitled'
+    #     money  :salary
+    #   end
     module Fields
       extend ActiveSupport::Concern
 
       TYPE_MAPPINGS = {
-        string: String,
-        date: Date,
+        string:   String,
+        date:     Date,
         datetime: DateTime,
-        money: BigDecimal,
-        integer: Integer,
-        number: BigDecimal
+        money:    BigDecimal,
+        number:   BigDecimal,
+        integer:  Integer
       }
 
       included do
@@ -19,6 +32,8 @@ module Filemaker
         self.fields = {}
       end
 
+      # Apply default value when you instantiate a new model.
+      # @See Model.new
       def apply_defaults
         attribute_names.each do |name|
           field = fields[name]
@@ -53,15 +68,27 @@ module Filemaker
         end
 
         def add_field(name, type, options)
+          name = name.to_s
           fields[name] = Filemaker::Model::Field.new(name, type, options)
           self.identity = fields[name] if options[:identity]
         end
 
         def create_accessors(name)
+          name = name.to_s # Normalize it so ActiveModel::Serialization can work
+
+          define_attribute_methods name
+
+          # Reader
           define_method(name) { attributes[name] }
+
+          # Writer - We try to map to the correct type, if not we just return
+          # original.
           define_method("#{name}=") do |value|
+            public_send("#{name}_will_change!") unless value == attributes[name]
             attributes[name] = fields[name].coerce(value)
           end
+
+          # Predicate
           define_method("#{name}?") do
             attributes[name] == true || attributes[name].present?
           end
@@ -70,8 +97,9 @@ module Filemaker
         # Find FileMaker's real name given either the attribute name or the real
         # FileMaker name.
         def find_field_by_name(name)
+          name = name.to_s
           fields.values.find do |f|
-            f.name == name.to_sym || f.fm_name == name.to_s
+            f.name == name || f.fm_name == name
           end
         end
       end

data/lib/filemaker/model/persistable.rb

@@ -35,12 +35,14 @@ module Filemaker
 
       def update
         return false unless valid?
+        return true if dirty_attributes.empty?
 
         run_callbacks :update do
           # Will raise `RecordModificationIdMismatchError` if does not match
           options = { modid: mod_id } # Always pass in?
           yield options if block_given?
-          resultset = api.edit(record_id, fm_attributes, options)
+          resultset = api.edit(record_id, dirty_attributes, options)
+          changes_applied
           replace_new_data(resultset)
         end
         self
@@ -70,11 +72,21 @@ module Filemaker
       # `fm_attributes`
       def assign_attributes(new_attributes)
         return if new_attributes.blank?
+
         new_attributes.each_pair do |key, value|
-          public_send("#{key}=", (value || '')) if respond_to?("#{key}=")
+          next unless respond_to?("#{key}=")
+
+          public_send("#{key}=", (value || ''))
         end
       end
 
+      def reload!
+        reset_changes
+        resultset = api.find(record_id)
+        replace_new_data(resultset)
+        self
+      end
+
       private
 
       # If you have calculated field from FileMaker, it will be replaced.
@@ -90,7 +102,8 @@ module Filemaker
           field = self.class.find_field_by_name(fm_field_name)
           next unless field
 
-          public_send("#{field.name}=", record[fm_field_name])
+          # Because we are using ActiveModel::Dirty, so we hydrate directly.
+          attributes[field.name] = field.coerce(record[fm_field_name])
         end
       end
     end

data/lib/filemaker/model.rb

@@ -49,6 +49,14 @@ module Filemaker
       self.class.with_model_fields(attributes)
     end
 
+    def dirty_attributes
+      dirty = {}
+      changed.each do |attr_name|
+        dirty[attr_name] = attributes[attr_name]
+      end
+      self.class.with_model_fields(dirty)
+    end
+
     private
 
     def process_attributes(attrs)

data/lib/filemaker/railtie.rb

@@ -9,7 +9,7 @@ module Rails
         if config_file.file?
           ::Filemaker.load!(config_file, Rails.env)
         else
-          fail ::Filemaker::Errors::ConfigurationError, 'No config file provided'
+          fail ::Filemaker::Errors::ConfigurationError, 'No config file'
         end
       end
     end

data/lib/filemaker/version.rb

@@ -1,3 +1,3 @@
 module Filemaker
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/lib/filemaker.rb

@@ -58,3 +58,15 @@ module Filemaker
 end
 
 require 'filemaker/railtie' if defined?(Rails)
+
+if defined?(Elasticsearch::Model)
+  require 'filemaker/elasticsearch/filemaker_adapter'
+
+  Elasticsearch::Model::Adapter.register(
+    ::Filemaker::Elasticsearch::FilemakerAdapter,
+    lambda do |klass|
+      !!defined?(::Filemaker::Model) && \
+        klass.ancestors.include?(::Filemaker::Model)
+    end
+  )
+end

data/lib/generators/filemaker/model/model_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+
+module Filemaker
+  module Generators
+    class ModelGenerator < ::Rails::Generators::NamedBase
+      desc 'Create FileMaker model.'
+      argument :db, type: :string, required: true
+      argument :lay, type: :string, required: true
+      argument :registry, type: :string, required: false
+
+      def self.source_root
+        @source_root ||= File.expand_path(
+          File.join(File.dirname(__FILE__), 'templates')
+        )
+      end
+
+      def create_model_file
+        server = Filemaker.registry[registry || 'default']
+        api = server.db[db][lay]
+        @fields = api.view.fields.values.map do |field|
+          [field.name, field.data_type]
+        end
+
+        @type_mappings = {
+          'text' => 'string',
+          'number' => 'number',
+          'date' => 'date',
+          'time' => 'datetime',
+          'timestamp' => 'datetime'
+        }
+
+        template(
+          'model.rb',
+          File.join('app/models', class_path, "#{file_name}.rb")
+        )
+      end
+    end
+  end
+end

data/lib/generators/filemaker/model/templates/model.rb

@@ -0,0 +1,12 @@
+<% module_namespacing do -%>
+class <%= class_name %>
+  include Filemaker::Model
+
+  database '<%= db %>'
+  layout '<%= lay %>'
+
+<% @fields.map do |name, type| -%>
+  <%= @type_mappings[type] %> :<%= name.parameterize.underscore %>, fm_name: '<%= name %>'
+<% end -%>
+end
+<% end %>

data/spec/filemaker/layout_spec.rb

@@ -11,7 +11,7 @@ describe Filemaker::Layout do
 
     before do
       @server = Filemaker::Server.new do |config|
-        config.host         = 'host'
+        config.host         = 'example'
         config.account_name = 'account_name'
         config.password     = 'password'
       end

data/spec/filemaker/model/relations_spec.rb

@@ -53,7 +53,7 @@ describe Filemaker::Model::Relations do
 
     context 'when using default reference_key' do
       it 'will use owner identity name' do
-        expect(@model.posts.reference_key).to eq :candidate_id
+        expect(@model.posts.reference_key).to eq 'candidate_id'
       end
 
       it 'target class should be Post' do

data/spec/filemaker/model_spec.rb

@@ -12,10 +12,10 @@ describe Filemaker::Model do
   it 'sets up server and api' do
     expect(MyModel.api.default_params).to eq \
       ({ '-db' => :candidates, '-lay' => :profile })
-    expect(MyModel.server.host).to eq 'host'
+    expect(MyModel.server.host).to eq 'example'
     expect(model.api.default_params).to eq \
       ({ '-db' => :candidates, '-lay' => :profile })
-    expect(model.server.host).to eq 'host'
+    expect(model.server.host).to eq 'example'
   end
 
   it 'is a new record' do
@@ -78,4 +78,17 @@ describe Filemaker::Model do
     end
   end
 
+  context 'dirty attributes' do
+    it 'does not track changes for new model' do
+      expect(model.changed?).to be false
+    end
+
+    it 'tracks changes' do
+      model.name = 'Bob'
+      expect(model.changed?).to be true
+      expect(model.changed).to eq ['name']
+      expect(model.dirty_attributes).to eq({'name' => 'Bob'})
+    end
+  end
+
 end

data/spec/filemaker/server_spec.rb

@@ -3,13 +3,13 @@ describe Filemaker::Server do
   context 'initializing a server' do
     it 'provides a host, account_name, and password' do
       server = Filemaker::Server.new do |config|
-        config.host         = 'host'
+        config.host         = 'example'
         config.account_name = 'account_name'
         config.password     = 'password'
       end
 
-      expect(server.host).to eq 'host'
-      expect(server.url).to eq 'http://host'
+      expect(server.host).to eq 'example'
+      expect(server.url).to eq 'http://example'
       expect(server.account_name).to eq 'account_name'
       expect(server.password).to eq 'password'
       expect(server.connection).to be_a Faraday::Connection
@@ -21,13 +21,13 @@ describe Filemaker::Server do
 
     it 'specifically ask for no SSL' do
       server = Filemaker::Server.new do |config|
-        config.host         = 'host'
+        config.host         = 'example'
         config.account_name = 'account_name'
         config.password     = 'password'
         config.ssl          = false
       end
 
-      expect(server.url).to eq 'http://host'
+      expect(server.url).to eq 'http://example'
     end
 
     it 'did not provide host, account_name, and password' do
@@ -36,7 +36,7 @@ describe Filemaker::Server do
       end.to raise_error ArgumentError
 
       expect do
-        Filemaker::Server.new { |config| config.host = 'host' }
+        Filemaker::Server.new { |config| config.host = 'example' }
       end.to raise_error ArgumentError
     end
   end
@@ -44,13 +44,13 @@ describe Filemaker::Server do
   context 'initializing a server with SSL' do
     it 'indicates secured connection' do
       server = Filemaker::Server.new do |config|
-        config.host         = 'host'
+        config.host         = 'example'
         config.account_name = 'account_name'
         config.password     = 'password'
         config.ssl          = { verify: false }
       end
 
-      expect(server.url).to eq 'https://host'
+      expect(server.url).to eq 'https://example'
       expect(server.connection.ssl[:verify]).to be false
     end
   end
@@ -58,7 +58,7 @@ describe Filemaker::Server do
   describe 'databases is a store to track encountered -db' do
     it 'stores database object and can be accessed with db and database' do
       server = Filemaker::Server.new do |config|
-        config.host         = 'host'
+        config.host         = 'example'
         config.account_name = 'account_name'
         config.password     = 'password'
       end
@@ -72,7 +72,7 @@ describe Filemaker::Server do
   context 'HTTP errors' do
     before do
       @server = Filemaker::Server.new do |config|
-        config.host         = 'host'
+        config.host         = 'example'
         config.account_name = 'account_name'
         config.password     = 'password'
       end

data/spec/filemaker/store/database_store_spec.rb

@@ -16,7 +16,7 @@ describe Filemaker::Store::DatabaseStore do
   describe 'all' do
     it 'returns all databases' do
       server = Filemaker::Server.new do |config|
-        config.host         = 'host'
+        config.host         = 'example'
         config.account_name = 'account_name'
         config.password     = 'password'
       end

data/spec/filemaker/store/layout_store_spec.rb

@@ -16,7 +16,7 @@ describe Filemaker::Store::LayoutStore do
   describe 'all' do
     it 'returns all layouts for a database' do
       server = Filemaker::Server.new do |config|
-        config.host         = 'host'
+        config.host         = 'example'
         config.account_name = 'account_name'
         config.password     = 'password'
       end

data/spec/filemaker/store/script_store_spec.rb

@@ -16,7 +16,7 @@ describe Filemaker::Store::ScriptStore do
   describe 'all' do
     it 'returns all scripts for a database' do
       server = Filemaker::Server.new do |config|
-        config.host         = 'host'
+        config.host         = 'example'
         config.account_name = 'account_name'
         config.password     = 'password'
       end

data/spec/support/models.rb

@@ -1,5 +1,5 @@
 Filemaker.registry['default'] = Filemaker::Server.new do |config|
-  config.host         = 'host'
+  config.host         = 'example'
   config.account_name = 'account_name'
   config.password     = 'password'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filemaker
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - mech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -167,6 +167,7 @@ files:
 - lib/filemaker/configuration.rb
 - lib/filemaker/core_ext/hash.rb
 - lib/filemaker/database.rb
+- lib/filemaker/elasticsearch/filemaker_adapter.rb
 - lib/filemaker/errors.rb
 - lib/filemaker/layout.rb
 - lib/filemaker/metadata/field.rb
@@ -195,6 +196,8 @@ files:
 - lib/filemaker/store/layout_store.rb
 - lib/filemaker/store/script_store.rb
 - lib/filemaker/version.rb
+- lib/generators/filemaker/model/model_generator.rb
+- lib/generators/filemaker/model/templates/model.rb
 - spec/filemaker/api/query_commands/compound_find_spec.rb
 - spec/filemaker/configuration_spec.rb
 - spec/filemaker/error_spec.rb